Microsoft.EventHub (preview:2024-05-01)

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

ApplicationGroup_ListByNamespace (new)
Description :  Gets a list of application groups for a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/applicationGroups
{
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 Application Groups operation. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
isEnabled:
{
Description: Determines if Application Group is allowed to create connection with namespace or not. Once the isEnabled is set to false, all the existing connections of application group gets dropped and no new connections will be allowed ,
Required: False ,
}
boolean ,
clientAppGroupIdentifier:
{
Description: The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid) ,
Required: True ,
}
string ,
policies:
{
Description: List of group policies that define the behavior of application group. The policies can support resource governance scenarios such as limiting ingress or egress traffic. ,
Required: False ,
}
[
{
name:
{
Description: The Name of this policy ,
Required: True ,
}
string ,
type:
{
Description: Application Group Policy types ,
Enum:
{
ThrottlingPolicy: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
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)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/applicationGroups/{applicationGroupName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The Application Group name ,
Required: True ,
}
string ,
parameters:
{
Description: The ApplicationGroup. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
isEnabled:
{
Description: Determines if Application Group is allowed to create connection with namespace or not. Once the isEnabled is set to false, all the existing connections of application group gets dropped and no new connections will be allowed ,
Required: False ,
}
boolean ,
clientAppGroupIdentifier:
{
Description: The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid) ,
Required: True ,
}
string ,
policies:
{
Description: List of group policies that define the behavior of application group. The policies can support resource governance scenarios such as limiting ingress or egress traffic. ,
Required: False ,
}
[
{
name:
{
Description: The Name of this policy ,
Required: True ,
}
string ,
type:
{
Description: Application Group Policy types ,
Enum:
{
ThrottlingPolicy: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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:
{
Required: False ,
}
{
isEnabled:
{
Description: Determines if Application Group is allowed to create connection with namespace or not. Once the isEnabled is set to false, all the existing connections of application group gets dropped and no new connections will be allowed ,
Required: False ,
}
boolean ,
clientAppGroupIdentifier:
{
Description: The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid) ,
Required: True ,
}
string ,
policies:
{
Description: List of group policies that define the behavior of application group. The policies can support resource governance scenarios such as limiting ingress or egress traffic. ,
Required: False ,
}
[
{
name:
{
Description: The Name of this policy ,
Required: True ,
}
string ,
type:
{
Description: Application Group Policy types ,
Enum:
{
ThrottlingPolicy: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/applicationGroups/{applicationGroupName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The Application 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)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/applicationGroups/{applicationGroupName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The Application 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:
{
Required: False ,
}
{
isEnabled:
{
Description: Determines if Application Group is allowed to create connection with namespace or not. Once the isEnabled is set to false, all the existing connections of application group gets dropped and no new connections will be allowed ,
Required: False ,
}
boolean ,
clientAppGroupIdentifier:
{
Description: The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid) ,
Required: True ,
}
string ,
policies:
{
Description: List of group policies that define the behavior of application group. The policies can support resource governance scenarios such as limiting ingress or egress traffic. ,
Required: False ,
}
[
{
name:
{
Description: The Name of this policy ,
Required: True ,
}
string ,
type:
{
Description: Application Group Policy types ,
Enum:
{
ThrottlingPolicy: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdateAuthorizationRule (new)
Description :  Creates or updates an 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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_GetAuthorizationRule (new)
Description :  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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_RegenerateKeys (new)
Description :  Regenerates the primary or secondary connection strings 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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ListAvailableClusterRegion (new)
Description :  List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventHub/availableClusterRegions
{
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 ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The count of readily available and pre-provisioned Event Hubs Clusters per region. ,
Required: False ,
}
[
{
location:
{
Description: Location fo the Available Cluster ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CheckNameAvailability (new)
Description :  Check the 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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ListBySubscription (new)
Description :  Lists the available Event Hubs Clusters within an ARM resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventHub/clusters
{
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 ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Event Hubs Clusters present in the List Event Hubs operation results. ,
Required: False ,
}
[
{
sku:
{
Description: Properties of the cluster SKU. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Event Hubs Cluster properties supplied in responses in List or Get operations. ,
Required: False ,
}
{
createdAt:
{
Description: The UTC time when the Event Hubs Cluster was created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Cluster. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The UTC time when the Event Hubs Cluster was last updated. ,
Required: False ,
}
string ,
metricId:
{
Description: The metric ID of the cluster resource. Provided by the service and not modifiable by the user. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Cluster resource ,
Required: False ,
}
string ,
supportsScaling:
{
Description: A value that indicates whether Scaling is Supported. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Empty unless the value parameter contains an incomplete list of Event Hubs Clusters. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ListByResourceGroup (new)
Description :  Lists the available Event Hubs Clusters within an ARM resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters
{
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 ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Event Hubs Clusters present in the List Event Hubs operation results. ,
Required: False ,
}
[
{
sku:
{
Description: Properties of the cluster SKU. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Event Hubs Cluster properties supplied in responses in List or Get operations. ,
Required: False ,
}
{
createdAt:
{
Description: The UTC time when the Event Hubs Cluster was created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Cluster. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The UTC time when the Event Hubs Cluster was last updated. ,
Required: False ,
}
string ,
metricId:
{
Description: The metric ID of the cluster resource. Provided by the service and not modifiable by the user. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Cluster resource ,
Required: False ,
}
string ,
supportsScaling:
{
Description: A value that indicates whether Scaling is Supported. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Empty unless the value parameter contains an incomplete list of Event Hubs Clusters. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Get (new)
Description :  Gets the resource description of the specified Event Hubs Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}
{
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 ,
clusterName:
{
Description: The name of the Event Hubs Cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Properties of the cluster SKU. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Event Hubs Cluster properties supplied in responses in List or Get operations. ,
Required: False ,
}
{
createdAt:
{
Description: The UTC time when the Event Hubs Cluster was created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Cluster. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The UTC time when the Event Hubs Cluster was last updated. ,
Required: False ,
}
string ,
metricId:
{
Description: The metric ID of the cluster resource. Provided by the service and not modifiable by the user. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Cluster resource ,
Required: False ,
}
string ,
supportsScaling:
{
Description: A value that indicates whether Scaling is Supported. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_CreateOrUpdate (new)
Description :  Creates or updates an instance of an Event Hubs Cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}
{
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 ,
clusterName:
{
Description: The name of the Event Hubs Cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for creating a eventhub cluster resource. ,
Required: True ,
}
{
sku:
{
Description: Properties of the cluster SKU. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Event Hubs Cluster properties supplied in responses in List or Get operations. ,
Required: False ,
}
{
createdAt:
{
Description: The UTC time when the Event Hubs Cluster was created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Cluster. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The UTC time when the Event Hubs Cluster was last updated. ,
Required: False ,
}
string ,
metricId:
{
Description: The metric ID of the cluster resource. Provided by the service and not modifiable by the user. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Cluster resource ,
Required: False ,
}
string ,
supportsScaling:
{
Description: A value that indicates whether Scaling is Supported. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Properties of the cluster SKU. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Event Hubs Cluster properties supplied in responses in List or Get operations. ,
Required: False ,
}
{
createdAt:
{
Description: The UTC time when the Event Hubs Cluster was created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Cluster. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The UTC time when the Event Hubs Cluster was last updated. ,
Required: False ,
}
string ,
metricId:
{
Description: The metric ID of the cluster resource. Provided by the service and not modifiable by the user. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Cluster resource ,
Required: False ,
}
string ,
supportsScaling:
{
Description: A value that indicates whether Scaling is Supported. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: Properties of the cluster SKU. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Event Hubs Cluster properties supplied in responses in List or Get operations. ,
Required: False ,
}
{
createdAt:
{
Description: The UTC time when the Event Hubs Cluster was created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Cluster. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The UTC time when the Event Hubs Cluster was last updated. ,
Required: False ,
}
string ,
metricId:
{
Description: The metric ID of the cluster resource. Provided by the service and not modifiable by the user. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Cluster resource ,
Required: False ,
}
string ,
supportsScaling:
{
Description: A value that indicates whether Scaling is Supported. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Update (new)
Description :  Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}
{
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 ,
clusterName:
{
Description: The name of the Event Hubs Cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the Event Hubs Cluster which should be updated. ,
Required: True ,
}
{
sku:
{
Description: Properties of the cluster SKU. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Event Hubs Cluster properties supplied in responses in List or Get operations. ,
Required: False ,
}
{
createdAt:
{
Description: The UTC time when the Event Hubs Cluster was created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Cluster. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The UTC time when the Event Hubs Cluster was last updated. ,
Required: False ,
}
string ,
metricId:
{
Description: The metric ID of the cluster resource. Provided by the service and not modifiable by the user. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Cluster resource ,
Required: False ,
}
string ,
supportsScaling:
{
Description: A value that indicates whether Scaling is Supported. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
Description: Properties of the cluster SKU. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Event Hubs Cluster properties supplied in responses in List or Get operations. ,
Required: False ,
}
{
createdAt:
{
Description: The UTC time when the Event Hubs Cluster was created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Cluster. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The UTC time when the Event Hubs Cluster was last updated. ,
Required: False ,
}
string ,
metricId:
{
Description: The metric ID of the cluster resource. Provided by the service and not modifiable by the user. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Cluster resource ,
Required: False ,
}
string ,
supportsScaling:
{
Description: A value that indicates whether Scaling is Supported. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: Properties of the cluster SKU. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Event Hubs Cluster properties supplied in responses in List or Get operations. ,
Required: False ,
}
{
createdAt:
{
Description: The UTC time when the Event Hubs Cluster was created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Cluster. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The UTC time when the Event Hubs Cluster was last updated. ,
Required: False ,
}
string ,
metricId:
{
Description: The metric ID of the cluster resource. Provided by the service and not modifiable by the user. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Cluster resource ,
Required: False ,
}
string ,
supportsScaling:
{
Description: A value that indicates whether Scaling is Supported. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Delete (new)
Description :  Deletes an existing Event Hubs Cluster. This operation is idempotent.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}
{
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 ,
clusterName:
{
Description: The name of the Event Hubs Cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ListNamespaces (new)
Description :  List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/namespaces
{
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 ,
clusterName:
{
Description: The name of the Event Hubs Cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Namespace IDs operation ,
Required: False ,
}
[
{
id:
{
Description: id parameter ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SchemaRegistry_ListByNamespace (new)
Description :  Gets all the Schema Groups in a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/schemagroups
{
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 SchemaGroups operation. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
updatedAtUtc:
{
Description: Exact time the Schema Group was updated ,
Format: date-time ,
Required: False ,
}
string ,
createdAtUtc:
{
Description: Exact time the Schema Group was created. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value. ,
Format: uuid ,
Required: False ,
}
string ,
groupProperties:
{
Description: dictionary object for SchemaGroup group properties ,
Required: False ,
}
object ,
schemaCompatibility:
{
Enum:
{
None: No description available. ,
Backward: No description available. ,
Forward: No description available. ,
}
,
Required: False ,
}
enum ,
schemaType:
{
Enum:
{
Unknown: No description available. ,
Avro: No description available. ,
ProtoBuf: No description available. ,
Json: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Schema Groups. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SchemaRegistry_CreateOrUpdate (new)
Description :  Creates or Updates an EventHub schema group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/schemagroups/{schemaGroupName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
schemaGroupName:
{
Description: The Schema Group name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create an Event Hub resource. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
updatedAtUtc:
{
Description: Exact time the Schema Group was updated ,
Format: date-time ,
Required: False ,
}
string ,
createdAtUtc:
{
Description: Exact time the Schema Group was created. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value. ,
Format: uuid ,
Required: False ,
}
string ,
groupProperties:
{
Description: dictionary object for SchemaGroup group properties ,
Required: False ,
}
object ,
schemaCompatibility:
{
Enum:
{
None: No description available. ,
Backward: No description available. ,
Forward: No description available. ,
}
,
Required: False ,
}
enum ,
schemaType:
{
Enum:
{
Unknown: No description available. ,
Avro: No description available. ,
ProtoBuf: No description available. ,
Json: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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:
{
Required: False ,
}
{
updatedAtUtc:
{
Description: Exact time the Schema Group was updated ,
Format: date-time ,
Required: False ,
}
string ,
createdAtUtc:
{
Description: Exact time the Schema Group was created. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value. ,
Format: uuid ,
Required: False ,
}
string ,
groupProperties:
{
Description: dictionary object for SchemaGroup group properties ,
Required: False ,
}
object ,
schemaCompatibility:
{
Enum:
{
None: No description available. ,
Backward: No description available. ,
Forward: No description available. ,
}
,
Required: False ,
}
enum ,
schemaType:
{
Enum:
{
Unknown: No description available. ,
Avro: No description available. ,
ProtoBuf: No description available. ,
Json: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SchemaRegistry_Delete (new)
Description :  Deletes an EventHub schema group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/schemagroups/{schemaGroupName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
schemaGroupName:
{
Description: The Schema 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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SchemaRegistry_Get (new)
Description :  Gets the details of an EventHub schema group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/schemagroups/{schemaGroupName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
schemaGroupName:
{
Description: The Schema 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:
{
Required: False ,
}
{
updatedAtUtc:
{
Description: Exact time the Schema Group was updated ,
Format: date-time ,
Required: False ,
}
string ,
createdAtUtc:
{
Description: Exact time the Schema Group was created. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value. ,
Format: uuid ,
Required: False ,
}
string ,
groupProperties:
{
Description: dictionary object for SchemaGroup group properties ,
Required: False ,
}
object ,
schemaCompatibility:
{
Enum:
{
None: No description available. ,
Backward: No description available. ,
Forward: No description available. ,
}
,
Required: False ,
}
enum ,
schemaType:
{
Enum:
{
Unknown: No description available. ,
Avro: No description available. ,
ProtoBuf: No description available. ,
Json: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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: 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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
identity:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
{
type:
{
Description: Type of Azure Active Directory Managed Identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: ARM ID of Managed User Identity. This property is required is the type is UserAssignedIdentity. If type is SystemAssigned, then the System Assigned Identity Associated with the namespace will be used. ,
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 ,
dataLakeSubscriptionId:
{
Description: Subscription Id of Azure Data Lake Store ,
Format: uuid ,
Required: False ,
}
string ,
dataLakeAccountName:
{
Description: The Azure Data Lake Store name for the captured events ,
Required: False ,
}
string ,
dataLakeFolderPath:
{
Description: The destination folder path for the captured events ,
Required: False ,
}
string ,
}
,
}
,
skipEmptyArchives:
{
Description: A value that indicates whether to Skip Empty Archives ,
Required: False ,
}
boolean ,
}
,
retentionDescription:
{
Description: Event Hub retention settings ,
Required: False ,
}
{
cleanupPolicy:
{
Description: Enumerates the possible values for cleanup policy ,
Enum:
{
Delete: No description available. ,
Compact: No description available. ,
DeleteOrCompact: No description available. ,
}
,
Required: False ,
}
enum ,
retentionTimeInHours:
{
Description: Number of hours to retain the events for this Event Hub. This should be positive value upto namespace SKU max. -1 is a special case where retention time is infinite, but the size of an entity is restricted and its size depends on namespace SKU type. ,
Format: int64 ,
Required: False ,
}
integer ,
minCompactionLagTimeInMinutes:
{
Description: The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact. ,
Format: int64 ,
Required: False ,
}
integer ,
tombstoneRetentionTimeInHours:
{
Description: Number of hours to retain the tombstone markers of a compacted Event Hub. This value is used when cleanupPolicy is Compact or DeleteOrCompact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
messageTimestampDescription:
{
Description: Properties of MessageTimestamp Description ,
Required: False ,
}
{
timestampType:
{
Description: Denotes the type of timestamp the message will hold.Two types of timestamp types - "AppendTime" and "CreateTime". AppendTime refers the time in which message got appended inside broker log. CreateTime refers to the time in which the message was generated on source side and producers can set this timestamp while sending the message. Default value is AppendTime. If you are using AMQP protocol, CreateTime equals AppendTime and its behavior remains the same. ,
Enum:
{
LogAppend: No description available. ,
Create: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identifier:
{
Description: Denotes the unique identifier for event hub and is generated by service while creating topic. This identifier can be used in kafka runtime apis wherever a UUID is required e.g Fetch & Delete Topic. This identifier is not supported in AMQP runtime operations yet. ,
Required: False ,
}
string ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of EventHubs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
identity:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
{
type:
{
Description: Type of Azure Active Directory Managed Identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: ARM ID of Managed User Identity. This property is required is the type is UserAssignedIdentity. If type is SystemAssigned, then the System Assigned Identity Associated with the namespace will be used. ,
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 ,
dataLakeSubscriptionId:
{
Description: Subscription Id of Azure Data Lake Store ,
Format: uuid ,
Required: False ,
}
string ,
dataLakeAccountName:
{
Description: The Azure Data Lake Store name for the captured events ,
Required: False ,
}
string ,
dataLakeFolderPath:
{
Description: The destination folder path for the captured events ,
Required: False ,
}
string ,
}
,
}
,
skipEmptyArchives:
{
Description: A value that indicates whether to Skip Empty Archives ,
Required: False ,
}
boolean ,
}
,
retentionDescription:
{
Description: Event Hub retention settings ,
Required: False ,
}
{
cleanupPolicy:
{
Description: Enumerates the possible values for cleanup policy ,
Enum:
{
Delete: No description available. ,
Compact: No description available. ,
DeleteOrCompact: No description available. ,
}
,
Required: False ,
}
enum ,
retentionTimeInHours:
{
Description: Number of hours to retain the events for this Event Hub. This should be positive value upto namespace SKU max. -1 is a special case where retention time is infinite, but the size of an entity is restricted and its size depends on namespace SKU type. ,
Format: int64 ,
Required: False ,
}
integer ,
minCompactionLagTimeInMinutes:
{
Description: The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact. ,
Format: int64 ,
Required: False ,
}
integer ,
tombstoneRetentionTimeInHours:
{
Description: Number of hours to retain the tombstone markers of a compacted Event Hub. This value is used when cleanupPolicy is Compact or DeleteOrCompact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
messageTimestampDescription:
{
Description: Properties of MessageTimestamp Description ,
Required: False ,
}
{
timestampType:
{
Description: Denotes the type of timestamp the message will hold.Two types of timestamp types - "AppendTime" and "CreateTime". AppendTime refers the time in which message got appended inside broker log. CreateTime refers to the time in which the message was generated on source side and producers can set this timestamp while sending the message. Default value is AppendTime. If you are using AMQP protocol, CreateTime equals AppendTime and its behavior remains the same. ,
Enum:
{
LogAppend: No description available. ,
Create: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identifier:
{
Description: Denotes the unique identifier for event hub and is generated by service while creating topic. This identifier can be used in kafka runtime apis wherever a UUID is required e.g Fetch & Delete Topic. This identifier is not supported in AMQP runtime operations yet. ,
Required: False ,
}
string ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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: 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 ,
identity:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
{
type:
{
Description: Type of Azure Active Directory Managed Identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: ARM ID of Managed User Identity. This property is required is the type is UserAssignedIdentity. If type is SystemAssigned, then the System Assigned Identity Associated with the namespace will be used. ,
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 ,
dataLakeSubscriptionId:
{
Description: Subscription Id of Azure Data Lake Store ,
Format: uuid ,
Required: False ,
}
string ,
dataLakeAccountName:
{
Description: The Azure Data Lake Store name for the captured events ,
Required: False ,
}
string ,
dataLakeFolderPath:
{
Description: The destination folder path for the captured events ,
Required: False ,
}
string ,
}
,
}
,
skipEmptyArchives:
{
Description: A value that indicates whether to Skip Empty Archives ,
Required: False ,
}
boolean ,
}
,
retentionDescription:
{
Description: Event Hub retention settings ,
Required: False ,
}
{
cleanupPolicy:
{
Description: Enumerates the possible values for cleanup policy ,
Enum:
{
Delete: No description available. ,
Compact: No description available. ,
DeleteOrCompact: No description available. ,
}
,
Required: False ,
}
enum ,
retentionTimeInHours:
{
Description: Number of hours to retain the events for this Event Hub. This should be positive value upto namespace SKU max. -1 is a special case where retention time is infinite, but the size of an entity is restricted and its size depends on namespace SKU type. ,
Format: int64 ,
Required: False ,
}
integer ,
minCompactionLagTimeInMinutes:
{
Description: The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact. ,
Format: int64 ,
Required: False ,
}
integer ,
tombstoneRetentionTimeInHours:
{
Description: Number of hours to retain the tombstone markers of a compacted Event Hub. This value is used when cleanupPolicy is Compact or DeleteOrCompact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
messageTimestampDescription:
{
Description: Properties of MessageTimestamp Description ,
Required: False ,
}
{
timestampType:
{
Description: Denotes the type of timestamp the message will hold.Two types of timestamp types - "AppendTime" and "CreateTime". AppendTime refers the time in which message got appended inside broker log. CreateTime refers to the time in which the message was generated on source side and producers can set this timestamp while sending the message. Default value is AppendTime. If you are using AMQP protocol, CreateTime equals AppendTime and its behavior remains the same. ,
Enum:
{
LogAppend: No description available. ,
Create: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identifier:
{
Description: Denotes the unique identifier for event hub and is generated by service while creating topic. This identifier can be used in kafka runtime apis wherever a UUID is required e.g Fetch & Delete Topic. This identifier is not supported in AMQP runtime operations yet. ,
Required: False ,
}
string ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
identity:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
{
type:
{
Description: Type of Azure Active Directory Managed Identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: ARM ID of Managed User Identity. This property is required is the type is UserAssignedIdentity. If type is SystemAssigned, then the System Assigned Identity Associated with the namespace will be used. ,
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 ,
dataLakeSubscriptionId:
{
Description: Subscription Id of Azure Data Lake Store ,
Format: uuid ,
Required: False ,
}
string ,
dataLakeAccountName:
{
Description: The Azure Data Lake Store name for the captured events ,
Required: False ,
}
string ,
dataLakeFolderPath:
{
Description: The destination folder path for the captured events ,
Required: False ,
}
string ,
}
,
}
,
skipEmptyArchives:
{
Description: A value that indicates whether to Skip Empty Archives ,
Required: False ,
}
boolean ,
}
,
retentionDescription:
{
Description: Event Hub retention settings ,
Required: False ,
}
{
cleanupPolicy:
{
Description: Enumerates the possible values for cleanup policy ,
Enum:
{
Delete: No description available. ,
Compact: No description available. ,
DeleteOrCompact: No description available. ,
}
,
Required: False ,
}
enum ,
retentionTimeInHours:
{
Description: Number of hours to retain the events for this Event Hub. This should be positive value upto namespace SKU max. -1 is a special case where retention time is infinite, but the size of an entity is restricted and its size depends on namespace SKU type. ,
Format: int64 ,
Required: False ,
}
integer ,
minCompactionLagTimeInMinutes:
{
Description: The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact. ,
Format: int64 ,
Required: False ,
}
integer ,
tombstoneRetentionTimeInHours:
{
Description: Number of hours to retain the tombstone markers of a compacted Event Hub. This value is used when cleanupPolicy is Compact or DeleteOrCompact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
messageTimestampDescription:
{
Description: Properties of MessageTimestamp Description ,
Required: False ,
}
{
timestampType:
{
Description: Denotes the type of timestamp the message will hold.Two types of timestamp types - "AppendTime" and "CreateTime". AppendTime refers the time in which message got appended inside broker log. CreateTime refers to the time in which the message was generated on source side and producers can set this timestamp while sending the message. Default value is AppendTime. If you are using AMQP protocol, CreateTime equals AppendTime and its behavior remains the same. ,
Enum:
{
LogAppend: No description available. ,
Create: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identifier:
{
Description: Denotes the unique identifier for event hub and is generated by service while creating topic. This identifier can be used in kafka runtime apis wherever a UUID is required e.g Fetch & Delete Topic. This identifier is not supported in AMQP runtime operations yet. ,
Required: False ,
}
string ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the Namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the Namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Cluster ARM ID of the Namespace. ,
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 ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
zoneRedundant:
{
Description: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Key Version ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Event Hubs namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: state of Namespace replica. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of namespaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListByResourceGroup (new)
Description :  Lists 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. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the Namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the Namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Cluster ARM ID of the Namespace. ,
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 ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
zoneRedundant:
{
Description: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Key Version ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Event Hubs namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: state of Namespace replica. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of namespaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdate (new)
Description :  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. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the Namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the Namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Cluster ARM ID of the Namespace. ,
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 ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
zoneRedundant:
{
Description: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Key Version ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Event Hubs namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: state of Namespace replica. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
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)

{
sku:
{
Description: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the Namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the Namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Cluster ARM ID of the Namespace. ,
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 ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
zoneRedundant:
{
Description: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Key Version ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Event Hubs namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: state of Namespace replica. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ 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. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the Namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the Namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Cluster ARM ID of the Namespace. ,
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 ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
zoneRedundant:
{
Description: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Key Version ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Event Hubs namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: state of Namespace replica. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

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

⚼ Request

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

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Get (new)
Description :  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. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the Namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the Namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Cluster ARM ID of the Namespace. ,
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 ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
zoneRedundant:
{
Description: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Key Version ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Event Hubs namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: state of Namespace replica. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_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. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the Namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the Namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Cluster ARM ID of the Namespace. ,
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 ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
zoneRedundant:
{
Description: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Key Version ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Event Hubs namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: state of Namespace replica. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
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)

{
sku:
{
Description: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the Namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the Namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Cluster ARM ID of the Namespace. ,
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 ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
zoneRedundant:
{
Description: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Key Version ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Event Hubs namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: state of Namespace replica. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ 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. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the Namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the Namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Cluster ARM ID of the Namespace. ,
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 ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
zoneRedundant:
{
Description: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Key Version ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Event Hubs namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: state of Namespace replica. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Failover (new)
Description :  GeoDR Failover
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/failover
{
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 ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for updating a namespace resource. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
primaryLocation:
{
Description: Query parameter for the new primary location after failover. ,
Required: False ,
}
string ,
force:
{
Description: If Force is false then graceful failover is attempted after ensuring no data loss. If Force flag is set to true, Forced failover is attempted with possible data loss. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials 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: A collection of private endpoint connection resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of private endpoint connection resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update Status of PrivateEndPoint Connection to namespace resource. ,
Required: True ,
}
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
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 ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials 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 of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (new)
Description :  Gets lists of resources that supports Privatelinks.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateLinkResources
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials 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: A collection of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link resource. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
id:
{
Description: Fully qualified identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: A link for the next page of private link resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfiguration_List (new)
Description :  Gets list of current NetworkSecurityPerimeterConfiguration for Namespace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkSecurityPerimeterConfigurations
{
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: A collection of NetworkSecurityPerimeterConfigurations ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Network Security Perimeter Configuration ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of NetworkSecurityPerimeter configuration propagation ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Accepted: No description available. ,
InvalidResponse: No description available. ,
Succeeded: No description available. ,
SucceededWithIssues: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: List of Provisioning Issues if any ,
Required: False ,
}
[
{
name:
{
Description: Name of the issue ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Provisioning Issue ,
Required: False ,
}
{
issueType:
{
Description: Type of Issue ,
Required: False ,
}
string ,
description:
{
Description: Description of the issue ,
Required: False ,
}
string ,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: NetworkSecurityPerimeter related information ,
Required: False ,
}
{
id:
{
Description: Fully qualified identifier of the resource ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the resource ,
Required: False ,
}
string ,
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Information about resource association ,
Required: False ,
}
{
name:
{
Description: Name of the resource association ,
Required: False ,
}
string ,
accessMode:
{
Description: Access Mode of the resource association ,
Enum:
{
NoAssociationMode: No description available. ,
EnforcedMode: No description available. ,
LearningMode: No description available. ,
AuditMode: No description available. ,
UnspecifiedMode: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Information about current network profile ,
Required: False ,
}
{
name:
{
Description: Name of the resource ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Current access rules version ,
Required: False ,
}
string ,
accessRules:
{
Description: List of Access Rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of the resource ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of the resource ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the resource ,
Required: False ,
}
string ,
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
isBackingResource:
{
Description: True if the EventHub namespace is backed by another Azure resource and not visible to end users. ,
Required: False ,
}
boolean ,
applicableFeatures:
{
Description: Indicates that the NSP controls related to backing association are only applicable to a specific feature in backing resource's data plane. ,
Required: False ,
}
[
string ,
]
,
parentAssociationName:
{
Description: Source Resource Association name ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: ARM Id of source resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfigurations_CreateOrUpdate (new)
Description :  Refreshes any information about the association.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkSecurityPerimeterConfigurations/{resourceAssociationName}/reconcile
{
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 ,
resourceAssociationName:
{
Description: The ResourceAssociation Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.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 ,
}
{
trustedServiceAccessEnabled:
{
Description: Value that indicates whether Trusted Service Access is Enabled or not. ,
Required: False ,
}
boolean ,
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: False ,
}
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
trustedServiceAccessEnabled:
{
Description: Value that indicates whether Trusted Service Access is Enabled or not. ,
Required: False ,
}
boolean ,
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: False ,
}
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
trustedServiceAccessEnabled:
{
Description: Value that indicates whether Trusted Service Access is Enabled or not. ,
Required: False ,
}
boolean ,
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: False ,
}
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListNetworkRuleSet (new)
Description :  Gets 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 ,
}
{
trustedServiceAccessEnabled:
{
Description: Value that indicates whether Trusted Service Access is Enabled or not. ,
Required: False ,
}
boolean ,
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: False ,
}
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of NetworkRuleSet. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (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 ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Description: Display of the operation ,
Required: False ,
}
{
provider:
{
Description: Resource provider of the operation ,
Required: False ,
}
string ,
resource:
{
Description: Resource of the operation ,
Required: False ,
}
string ,
operation:
{
Description: Localized friendly name for the operation ,
Required: False ,
}
string ,
description:
{
Description: Localized friendly description for the operation ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the operation ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configuration_Patch (new)
Description :  Replace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/quotaConfiguration/default
{
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 ,
clusterName:
{
Description: The name of the Event Hubs Cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for creating an Event Hubs Cluster resource. ,
Required: True ,
}
{
settings:
{
Description: All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster. ,
Required: True ,
}
object ,
}
,
}

⚐ Response (200)

{
settings:
{
Description: All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
settings:
{
Description: All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configuration_Get (new)
Description :  Get all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/quotaConfiguration/default
{
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 ,
clusterName:
{
Description: The name of the Event Hubs Cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
settings:
{
Description: All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster. ,
Required: False ,
}
object ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/applicationGroups
{
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 Application Groups operation. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
isEnabled:
{
Description: Determines if Application Group is allowed to create connection with namespace or not. Once the isEnabled is set to false, all the existing connections of application group gets dropped and no new connections will be allowed ,
Required: False ,
}
boolean ,
clientAppGroupIdentifier:
{
Description: The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid) ,
Required: True ,
}
string ,
policies:
{
Description: List of group policies that define the behavior of application group. The policies can support resource governance scenarios such as limiting ingress or egress traffic. ,
Required: False ,
}
[
{
name:
{
Description: The Name of this policy ,
Required: True ,
}
string ,
type:
{
Description: Application Group Policy types ,
Enum:
{
ThrottlingPolicy: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
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)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/applicationGroups/{applicationGroupName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The Application Group name ,
Required: True ,
}
string ,
parameters:
{
Description: The ApplicationGroup. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
isEnabled:
{
Description: Determines if Application Group is allowed to create connection with namespace or not. Once the isEnabled is set to false, all the existing connections of application group gets dropped and no new connections will be allowed ,
Required: False ,
}
boolean ,
clientAppGroupIdentifier:
{
Description: The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid) ,
Required: True ,
}
string ,
policies:
{
Description: List of group policies that define the behavior of application group. The policies can support resource governance scenarios such as limiting ingress or egress traffic. ,
Required: False ,
}
[
{
name:
{
Description: The Name of this policy ,
Required: True ,
}
string ,
type:
{
Description: Application Group Policy types ,
Enum:
{
ThrottlingPolicy: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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:
{
Required: False ,
}
{
isEnabled:
{
Description: Determines if Application Group is allowed to create connection with namespace or not. Once the isEnabled is set to false, all the existing connections of application group gets dropped and no new connections will be allowed ,
Required: False ,
}
boolean ,
clientAppGroupIdentifier:
{
Description: The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid) ,
Required: True ,
}
string ,
policies:
{
Description: List of group policies that define the behavior of application group. The policies can support resource governance scenarios such as limiting ingress or egress traffic. ,
Required: False ,
}
[
{
name:
{
Description: The Name of this policy ,
Required: True ,
}
string ,
type:
{
Description: Application Group Policy types ,
Enum:
{
ThrottlingPolicy: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/applicationGroups/{applicationGroupName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The Application 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)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/applicationGroups/{applicationGroupName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
applicationGroupName:
{
Description: The Application 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:
{
Required: False ,
}
{
isEnabled:
{
Description: Determines if Application Group is allowed to create connection with namespace or not. Once the isEnabled is set to false, all the existing connections of application group gets dropped and no new connections will be allowed ,
Required: False ,
}
boolean ,
clientAppGroupIdentifier:
{
Description: The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid) ,
Required: True ,
}
string ,
policies:
{
Description: List of group policies that define the behavior of application group. The policies can support resource governance scenarios such as limiting ingress or egress traffic. ,
Required: False ,
}
[
{
name:
{
Description: The Name of this policy ,
Required: True ,
}
string ,
type:
{
Description: Application Group Policy types ,
Enum:
{
ThrottlingPolicy: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdateAuthorizationRule (removed)
Description :  Creates or updates an 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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_GetAuthorizationRule (removed)
Description :  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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_RegenerateKeys (removed)
Description :  Regenerates the primary or secondary connection strings 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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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: Properties supplied to create or update AuthorizationRule ,
Required: False ,
}
{
rights:
{
Description: The rights associated with the rule. ,
Required: True ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ListAvailableClusterRegion (removed)
Description :  List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventHub/availableClusterRegions
{
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 ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The count of readily available and pre-provisioned Event Hubs Clusters per region. ,
Required: False ,
}
[
{
location:
{
Description: Location fo the Available Cluster ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CheckNameAvailability (removed)
Description :  Check the 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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ListBySubscription (removed)
Description :  Lists the available Event Hubs Clusters within an ARM resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.EventHub/clusters
{
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 ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Event Hubs Clusters present in the List Event Hubs operation results. ,
Required: False ,
}
[
{
sku:
{
Description: Properties of the cluster SKU. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Event Hubs Cluster properties supplied in responses in List or Get operations. ,
Required: False ,
}
{
createdAt:
{
Description: The UTC time when the Event Hubs Cluster was created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Cluster. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The UTC time when the Event Hubs Cluster was last updated. ,
Required: False ,
}
string ,
metricId:
{
Description: The metric ID of the cluster resource. Provided by the service and not modifiable by the user. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Cluster resource ,
Required: False ,
}
string ,
supportsScaling:
{
Description: A value that indicates whether Scaling is Supported. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Empty unless the value parameter contains an incomplete list of Event Hubs Clusters. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ListByResourceGroup (removed)
Description :  Lists the available Event Hubs Clusters within an ARM resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters
{
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 ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Event Hubs Clusters present in the List Event Hubs operation results. ,
Required: False ,
}
[
{
sku:
{
Description: Properties of the cluster SKU. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Event Hubs Cluster properties supplied in responses in List or Get operations. ,
Required: False ,
}
{
createdAt:
{
Description: The UTC time when the Event Hubs Cluster was created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Cluster. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The UTC time when the Event Hubs Cluster was last updated. ,
Required: False ,
}
string ,
metricId:
{
Description: The metric ID of the cluster resource. Provided by the service and not modifiable by the user. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Cluster resource ,
Required: False ,
}
string ,
supportsScaling:
{
Description: A value that indicates whether Scaling is Supported. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Empty unless the value parameter contains an incomplete list of Event Hubs Clusters. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Get (removed)
Description :  Gets the resource description of the specified Event Hubs Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}
{
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 ,
clusterName:
{
Description: The name of the Event Hubs Cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Properties of the cluster SKU. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Event Hubs Cluster properties supplied in responses in List or Get operations. ,
Required: False ,
}
{
createdAt:
{
Description: The UTC time when the Event Hubs Cluster was created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Cluster. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The UTC time when the Event Hubs Cluster was last updated. ,
Required: False ,
}
string ,
metricId:
{
Description: The metric ID of the cluster resource. Provided by the service and not modifiable by the user. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Cluster resource ,
Required: False ,
}
string ,
supportsScaling:
{
Description: A value that indicates whether Scaling is Supported. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_CreateOrUpdate (removed)
Description :  Creates or updates an instance of an Event Hubs Cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}
{
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 ,
clusterName:
{
Description: The name of the Event Hubs Cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for creating a eventhub cluster resource. ,
Required: True ,
}
{
sku:
{
Description: Properties of the cluster SKU. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Event Hubs Cluster properties supplied in responses in List or Get operations. ,
Required: False ,
}
{
createdAt:
{
Description: The UTC time when the Event Hubs Cluster was created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Cluster. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The UTC time when the Event Hubs Cluster was last updated. ,
Required: False ,
}
string ,
metricId:
{
Description: The metric ID of the cluster resource. Provided by the service and not modifiable by the user. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Cluster resource ,
Required: False ,
}
string ,
supportsScaling:
{
Description: A value that indicates whether Scaling is Supported. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Properties of the cluster SKU. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Event Hubs Cluster properties supplied in responses in List or Get operations. ,
Required: False ,
}
{
createdAt:
{
Description: The UTC time when the Event Hubs Cluster was created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Cluster. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The UTC time when the Event Hubs Cluster was last updated. ,
Required: False ,
}
string ,
metricId:
{
Description: The metric ID of the cluster resource. Provided by the service and not modifiable by the user. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Cluster resource ,
Required: False ,
}
string ,
supportsScaling:
{
Description: A value that indicates whether Scaling is Supported. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: Properties of the cluster SKU. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Event Hubs Cluster properties supplied in responses in List or Get operations. ,
Required: False ,
}
{
createdAt:
{
Description: The UTC time when the Event Hubs Cluster was created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Cluster. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The UTC time when the Event Hubs Cluster was last updated. ,
Required: False ,
}
string ,
metricId:
{
Description: The metric ID of the cluster resource. Provided by the service and not modifiable by the user. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Cluster resource ,
Required: False ,
}
string ,
supportsScaling:
{
Description: A value that indicates whether Scaling is Supported. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Update (removed)
Description :  Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}
{
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 ,
clusterName:
{
Description: The name of the Event Hubs Cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the Event Hubs Cluster which should be updated. ,
Required: True ,
}
{
sku:
{
Description: Properties of the cluster SKU. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Event Hubs Cluster properties supplied in responses in List or Get operations. ,
Required: False ,
}
{
createdAt:
{
Description: The UTC time when the Event Hubs Cluster was created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Cluster. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The UTC time when the Event Hubs Cluster was last updated. ,
Required: False ,
}
string ,
metricId:
{
Description: The metric ID of the cluster resource. Provided by the service and not modifiable by the user. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Cluster resource ,
Required: False ,
}
string ,
supportsScaling:
{
Description: A value that indicates whether Scaling is Supported. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
Description: Properties of the cluster SKU. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Event Hubs Cluster properties supplied in responses in List or Get operations. ,
Required: False ,
}
{
createdAt:
{
Description: The UTC time when the Event Hubs Cluster was created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Cluster. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The UTC time when the Event Hubs Cluster was last updated. ,
Required: False ,
}
string ,
metricId:
{
Description: The metric ID of the cluster resource. Provided by the service and not modifiable by the user. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Cluster resource ,
Required: False ,
}
string ,
supportsScaling:
{
Description: A value that indicates whether Scaling is Supported. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: Properties of the cluster SKU. ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: The quantity of Event Hubs Cluster Capacity Units contained in this cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Event Hubs Cluster properties supplied in responses in List or Get operations. ,
Required: False ,
}
{
createdAt:
{
Description: The UTC time when the Event Hubs Cluster was created. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Cluster. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Active: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: The UTC time when the Event Hubs Cluster was last updated. ,
Required: False ,
}
string ,
metricId:
{
Description: The metric ID of the cluster resource. Provided by the service and not modifiable by the user. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Cluster resource ,
Required: False ,
}
string ,
supportsScaling:
{
Description: A value that indicates whether Scaling is Supported. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Delete (removed)
Description :  Deletes an existing Event Hubs Cluster. This operation is idempotent.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}
{
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 ,
clusterName:
{
Description: The name of the Event Hubs Cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ListNamespaces (removed)
Description :  List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/namespaces
{
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 ,
clusterName:
{
Description: The name of the Event Hubs Cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List Namespace IDs operation ,
Required: False ,
}
[
{
id:
{
Description: id parameter ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SchemaRegistry_ListByNamespace (removed)
Description :  Gets all the Schema Groups in a Namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/schemagroups
{
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 SchemaGroups operation. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
updatedAtUtc:
{
Description: Exact time the Schema Group was updated ,
Format: date-time ,
Required: False ,
}
string ,
createdAtUtc:
{
Description: Exact time the Schema Group was created. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value. ,
Format: uuid ,
Required: False ,
}
string ,
groupProperties:
{
Description: dictionary object for SchemaGroup group properties ,
Required: False ,
}
object ,
schemaCompatibility:
{
Enum:
{
None: No description available. ,
Backward: No description available. ,
Forward: No description available. ,
}
,
Required: False ,
}
enum ,
schemaType:
{
Enum:
{
Unknown: No description available. ,
Avro: No description available. ,
ProtoBuf: No description available. ,
Json: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of Schema Groups. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SchemaRegistry_CreateOrUpdate (removed)
Description :  Creates or Updates an EventHub schema group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/schemagroups/{schemaGroupName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
schemaGroupName:
{
Description: The Schema Group name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create an Event Hub resource. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
updatedAtUtc:
{
Description: Exact time the Schema Group was updated ,
Format: date-time ,
Required: False ,
}
string ,
createdAtUtc:
{
Description: Exact time the Schema Group was created. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value. ,
Format: uuid ,
Required: False ,
}
string ,
groupProperties:
{
Description: dictionary object for SchemaGroup group properties ,
Required: False ,
}
object ,
schemaCompatibility:
{
Enum:
{
None: No description available. ,
Backward: No description available. ,
Forward: No description available. ,
}
,
Required: False ,
}
enum ,
schemaType:
{
Enum:
{
Unknown: No description available. ,
Avro: No description available. ,
ProtoBuf: No description available. ,
Json: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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:
{
Required: False ,
}
{
updatedAtUtc:
{
Description: Exact time the Schema Group was updated ,
Format: date-time ,
Required: False ,
}
string ,
createdAtUtc:
{
Description: Exact time the Schema Group was created. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value. ,
Format: uuid ,
Required: False ,
}
string ,
groupProperties:
{
Description: dictionary object for SchemaGroup group properties ,
Required: False ,
}
object ,
schemaCompatibility:
{
Enum:
{
None: No description available. ,
Backward: No description available. ,
Forward: No description available. ,
}
,
Required: False ,
}
enum ,
schemaType:
{
Enum:
{
Unknown: No description available. ,
Avro: No description available. ,
ProtoBuf: No description available. ,
Json: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SchemaRegistry_Delete (removed)
Description :  Deletes an EventHub schema group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/schemagroups/{schemaGroupName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
schemaGroupName:
{
Description: The Schema 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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SchemaRegistry_Get (removed)
Description :  Gets the details of an EventHub schema group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/schemagroups/{schemaGroupName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
schemaGroupName:
{
Description: The Schema 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:
{
Required: False ,
}
{
updatedAtUtc:
{
Description: Exact time the Schema Group was updated ,
Format: date-time ,
Required: False ,
}
string ,
createdAtUtc:
{
Description: Exact time the Schema Group was created. ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag value. ,
Format: uuid ,
Required: False ,
}
string ,
groupProperties:
{
Description: dictionary object for SchemaGroup group properties ,
Required: False ,
}
object ,
schemaCompatibility:
{
Enum:
{
None: No description available. ,
Backward: No description available. ,
Forward: No description available. ,
}
,
Required: False ,
}
enum ,
schemaType:
{
Enum:
{
Unknown: No description available. ,
Avro: No description available. ,
ProtoBuf: No description available. ,
Json: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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: 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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
identity:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
{
type:
{
Description: Type of Azure Active Directory Managed Identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: ARM ID of Managed User Identity. This property is required is the type is UserAssignedIdentity. If type is SystemAssigned, then the System Assigned Identity Associated with the namespace will be used. ,
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 ,
dataLakeSubscriptionId:
{
Description: Subscription Id of Azure Data Lake Store ,
Format: uuid ,
Required: False ,
}
string ,
dataLakeAccountName:
{
Description: The Azure Data Lake Store name for the captured events ,
Required: False ,
}
string ,
dataLakeFolderPath:
{
Description: The destination folder path for the captured events ,
Required: False ,
}
string ,
}
,
}
,
skipEmptyArchives:
{
Description: A value that indicates whether to Skip Empty Archives ,
Required: False ,
}
boolean ,
}
,
retentionDescription:
{
Description: Event Hub retention settings ,
Required: False ,
}
{
cleanupPolicy:
{
Description: Enumerates the possible values for cleanup policy ,
Enum:
{
Delete: No description available. ,
Compact: No description available. ,
DeleteOrCompact: No description available. ,
}
,
Required: False ,
}
enum ,
retentionTimeInHours:
{
Description: Number of hours to retain the events for this Event Hub. This should be positive value upto namespace SKU max. -1 is a special case where retention time is infinite, but the size of an entity is restricted and its size depends on namespace SKU type. ,
Format: int64 ,
Required: False ,
}
integer ,
minCompactionLagTimeInMinutes:
{
Description: The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact. ,
Format: int64 ,
Required: False ,
}
integer ,
tombstoneRetentionTimeInHours:
{
Description: Number of hours to retain the tombstone markers of a compacted Event Hub. This value is used when cleanupPolicy is Compact or DeleteOrCompact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
messageTimestampDescription:
{
Description: Properties of MessageTimestamp Description ,
Required: False ,
}
{
timestampType:
{
Description: Denotes the type of timestamp the message will hold.Two types of timestamp types - "AppendTime" and "CreateTime". AppendTime refers the time in which message got appended inside broker log. CreateTime refers to the time in which the message was generated on source side and producers can set this timestamp while sending the message. Default value is AppendTime. If you are using AMQP protocol, CreateTime equals AppendTime and its behavior remains the same. ,
Enum:
{
LogAppend: No description available. ,
Create: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identifier:
{
Description: Denotes the unique identifier for event hub and is generated by service while creating topic. This identifier can be used in kafka runtime apis wherever a UUID is required e.g Fetch & Delete Topic. This identifier is not supported in AMQP runtime operations yet. ,
Required: False ,
}
string ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of EventHubs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
identity:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
{
type:
{
Description: Type of Azure Active Directory Managed Identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: ARM ID of Managed User Identity. This property is required is the type is UserAssignedIdentity. If type is SystemAssigned, then the System Assigned Identity Associated with the namespace will be used. ,
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 ,
dataLakeSubscriptionId:
{
Description: Subscription Id of Azure Data Lake Store ,
Format: uuid ,
Required: False ,
}
string ,
dataLakeAccountName:
{
Description: The Azure Data Lake Store name for the captured events ,
Required: False ,
}
string ,
dataLakeFolderPath:
{
Description: The destination folder path for the captured events ,
Required: False ,
}
string ,
}
,
}
,
skipEmptyArchives:
{
Description: A value that indicates whether to Skip Empty Archives ,
Required: False ,
}
boolean ,
}
,
retentionDescription:
{
Description: Event Hub retention settings ,
Required: False ,
}
{
cleanupPolicy:
{
Description: Enumerates the possible values for cleanup policy ,
Enum:
{
Delete: No description available. ,
Compact: No description available. ,
DeleteOrCompact: No description available. ,
}
,
Required: False ,
}
enum ,
retentionTimeInHours:
{
Description: Number of hours to retain the events for this Event Hub. This should be positive value upto namespace SKU max. -1 is a special case where retention time is infinite, but the size of an entity is restricted and its size depends on namespace SKU type. ,
Format: int64 ,
Required: False ,
}
integer ,
minCompactionLagTimeInMinutes:
{
Description: The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact. ,
Format: int64 ,
Required: False ,
}
integer ,
tombstoneRetentionTimeInHours:
{
Description: Number of hours to retain the tombstone markers of a compacted Event Hub. This value is used when cleanupPolicy is Compact or DeleteOrCompact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
messageTimestampDescription:
{
Description: Properties of MessageTimestamp Description ,
Required: False ,
}
{
timestampType:
{
Description: Denotes the type of timestamp the message will hold.Two types of timestamp types - "AppendTime" and "CreateTime". AppendTime refers the time in which message got appended inside broker log. CreateTime refers to the time in which the message was generated on source side and producers can set this timestamp while sending the message. Default value is AppendTime. If you are using AMQP protocol, CreateTime equals AppendTime and its behavior remains the same. ,
Enum:
{
LogAppend: No description available. ,
Create: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identifier:
{
Description: Denotes the unique identifier for event hub and is generated by service while creating topic. This identifier can be used in kafka runtime apis wherever a UUID is required e.g Fetch & Delete Topic. This identifier is not supported in AMQP runtime operations yet. ,
Required: False ,
}
string ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
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: 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 ,
identity:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
{
type:
{
Description: Type of Azure Active Directory Managed Identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: ARM ID of Managed User Identity. This property is required is the type is UserAssignedIdentity. If type is SystemAssigned, then the System Assigned Identity Associated with the namespace will be used. ,
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 ,
dataLakeSubscriptionId:
{
Description: Subscription Id of Azure Data Lake Store ,
Format: uuid ,
Required: False ,
}
string ,
dataLakeAccountName:
{
Description: The Azure Data Lake Store name for the captured events ,
Required: False ,
}
string ,
dataLakeFolderPath:
{
Description: The destination folder path for the captured events ,
Required: False ,
}
string ,
}
,
}
,
skipEmptyArchives:
{
Description: A value that indicates whether to Skip Empty Archives ,
Required: False ,
}
boolean ,
}
,
retentionDescription:
{
Description: Event Hub retention settings ,
Required: False ,
}
{
cleanupPolicy:
{
Description: Enumerates the possible values for cleanup policy ,
Enum:
{
Delete: No description available. ,
Compact: No description available. ,
DeleteOrCompact: No description available. ,
}
,
Required: False ,
}
enum ,
retentionTimeInHours:
{
Description: Number of hours to retain the events for this Event Hub. This should be positive value upto namespace SKU max. -1 is a special case where retention time is infinite, but the size of an entity is restricted and its size depends on namespace SKU type. ,
Format: int64 ,
Required: False ,
}
integer ,
minCompactionLagTimeInMinutes:
{
Description: The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact. ,
Format: int64 ,
Required: False ,
}
integer ,
tombstoneRetentionTimeInHours:
{
Description: Number of hours to retain the tombstone markers of a compacted Event Hub. This value is used when cleanupPolicy is Compact or DeleteOrCompact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
messageTimestampDescription:
{
Description: Properties of MessageTimestamp Description ,
Required: False ,
}
{
timestampType:
{
Description: Denotes the type of timestamp the message will hold.Two types of timestamp types - "AppendTime" and "CreateTime". AppendTime refers the time in which message got appended inside broker log. CreateTime refers to the time in which the message was generated on source side and producers can set this timestamp while sending the message. Default value is AppendTime. If you are using AMQP protocol, CreateTime equals AppendTime and its behavior remains the same. ,
Enum:
{
LogAppend: No description available. ,
Create: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identifier:
{
Description: Denotes the unique identifier for event hub and is generated by service while creating topic. This identifier can be used in kafka runtime apis wherever a UUID is required e.g Fetch & Delete Topic. This identifier is not supported in AMQP runtime operations yet. ,
Required: False ,
}
string ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
identity:
{
Description: A value that indicates whether capture description is enabled. ,
Required: False ,
}
{
type:
{
Description: Type of Azure Active Directory Managed Identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentity:
{
Description: ARM ID of Managed User Identity. This property is required is the type is UserAssignedIdentity. If type is SystemAssigned, then the System Assigned Identity Associated with the namespace will be used. ,
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 ,
dataLakeSubscriptionId:
{
Description: Subscription Id of Azure Data Lake Store ,
Format: uuid ,
Required: False ,
}
string ,
dataLakeAccountName:
{
Description: The Azure Data Lake Store name for the captured events ,
Required: False ,
}
string ,
dataLakeFolderPath:
{
Description: The destination folder path for the captured events ,
Required: False ,
}
string ,
}
,
}
,
skipEmptyArchives:
{
Description: A value that indicates whether to Skip Empty Archives ,
Required: False ,
}
boolean ,
}
,
retentionDescription:
{
Description: Event Hub retention settings ,
Required: False ,
}
{
cleanupPolicy:
{
Description: Enumerates the possible values for cleanup policy ,
Enum:
{
Delete: No description available. ,
Compact: No description available. ,
DeleteOrCompact: No description available. ,
}
,
Required: False ,
}
enum ,
retentionTimeInHours:
{
Description: Number of hours to retain the events for this Event Hub. This should be positive value upto namespace SKU max. -1 is a special case where retention time is infinite, but the size of an entity is restricted and its size depends on namespace SKU type. ,
Format: int64 ,
Required: False ,
}
integer ,
minCompactionLagTimeInMinutes:
{
Description: The minimum time a message will remain ineligible for compaction in the log. This value is used when cleanupPolicy is Compact or DeleteOrCompact. ,
Format: int64 ,
Required: False ,
}
integer ,
tombstoneRetentionTimeInHours:
{
Description: Number of hours to retain the tombstone markers of a compacted Event Hub. This value is used when cleanupPolicy is Compact or DeleteOrCompact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
messageTimestampDescription:
{
Description: Properties of MessageTimestamp Description ,
Required: False ,
}
{
timestampType:
{
Description: Denotes the type of timestamp the message will hold.Two types of timestamp types - "AppendTime" and "CreateTime". AppendTime refers the time in which message got appended inside broker log. CreateTime refers to the time in which the message was generated on source side and producers can set this timestamp while sending the message. Default value is AppendTime. If you are using AMQP protocol, CreateTime equals AppendTime and its behavior remains the same. ,
Enum:
{
LogAppend: No description available. ,
Create: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identifier:
{
Description: Denotes the unique identifier for event hub and is generated by service while creating topic. This identifier can be used in kafka runtime apis wherever a UUID is required e.g Fetch & Delete Topic. This identifier is not supported in AMQP runtime operations yet. ,
Required: False ,
}
string ,
userMetadata:
{
Description: Gets and Sets Metadata of User. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the Namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the Namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Cluster ARM ID of the Namespace. ,
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 ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
zoneRedundant:
{
Description: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Key Version ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Event Hubs namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: state of Namespace replica. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of namespaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListByResourceGroup (removed)
Description :  Lists 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. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the Namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the Namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Cluster ARM ID of the Namespace. ,
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 ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
zoneRedundant:
{
Description: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Key Version ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Event Hubs namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: state of Namespace replica. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of namespaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrUpdate (removed)
Description :  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. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the Namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the Namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Cluster ARM ID of the Namespace. ,
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 ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
zoneRedundant:
{
Description: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Key Version ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Event Hubs namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: state of Namespace replica. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
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)

{
sku:
{
Description: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the Namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the Namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Cluster ARM ID of the Namespace. ,
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 ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
zoneRedundant:
{
Description: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Key Version ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Event Hubs namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: state of Namespace replica. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ 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. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the Namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the Namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Cluster ARM ID of the Namespace. ,
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 ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
zoneRedundant:
{
Description: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Key Version ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Event Hubs namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: state of Namespace replica. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

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

⚼ Request

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

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Get (removed)
Description :  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. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the Namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the Namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Cluster ARM ID of the Namespace. ,
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 ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
zoneRedundant:
{
Description: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Key Version ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Event Hubs namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: state of Namespace replica. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_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. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the Namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the Namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Cluster ARM ID of the Namespace. ,
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 ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
zoneRedundant:
{
Description: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Key Version ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Event Hubs namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: state of Namespace replica. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
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)

{
sku:
{
Description: Properties of sku resource ,
Required: False ,
}
{
name:
{
Description: Name of this SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the Namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the Namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Cluster ARM ID of the Namespace. ,
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 ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
zoneRedundant:
{
Description: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Key Version ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Event Hubs namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: state of Namespace replica. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ 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. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The billing tier of this particular SKU. ,
Enum:
{
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Properties of BYOK Identity description ,
Required: False ,
}
{
principalId:
{
Description: ObjectId from the KeyVault ,
Required: False ,
}
string ,
tenantId:
{
Description: TenantId from the KeyVault ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: Properties for User Assigned Identities ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Namespace properties supplied for create namespace operation. ,
Required: False ,
}
{
minimumTlsVersion:
{
Description: The minimum TLS version for the cluster to support, e.g. '1.2' ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Namespace. ,
Required: False ,
}
string ,
status:
{
Description: Status of the Namespace. ,
Required: False ,
}
string ,
createdAt:
{
Description: The time the Namespace was created. ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: The time the Namespace was updated. ,
Format: date-time ,
Required: False ,
}
string ,
serviceBusEndpoint:
{
Description: Endpoint you can use to perform Service Bus operations. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Cluster ARM ID of the Namespace. ,
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 ,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
zoneRedundant:
{
Description: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. ,
Required: False ,
}
boolean ,
encryption:
{
Description: Properties of BYOK Encryption description ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Properties of KeyVault ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the Key from KeyVault ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: Uri of KeyVault ,
Required: False ,
}
string ,
keyVersion:
{
Description: Key Version ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
{
userAssignedIdentity:
{
Description: ARM ID of user Identity selected for encryption ,
Required: False ,
}
string ,
}
,
}
,
]
,
keySource:
{
Description: Enumerates the possible value of keySource for Encryption ,
Enum:
{
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: Enable Infrastructure Encryption (Double Encryption) ,
Required: False ,
}
boolean ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
disableLocalAuth:
{
Description: This property disables SAS authentication for the Event Hubs namespace. ,
Required: False ,
}
boolean ,
alternateName:
{
Description: Alternate name specified when alias and namespace names are same. ,
Required: False ,
}
string ,
geoDataReplication:
{
Description: Geo Data Replication settings for the namespace ,
Required: False ,
}
{
maxReplicationLagDurationInSeconds:
{
Description: The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. ,
Format: int32 ,
Required: False ,
}
integer ,
locations:
{
Description: A list of regions where replicas of the namespace are maintained. ,
Required: False ,
}
[
{
locationName:
{
Description: Azure regions where a replica of the namespace is maintained ,
Required: False ,
}
string ,
roleType:
{
Description: GeoDR Role Types ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicaState:
{
Description: state of Namespace replica. ,
Required: False ,
}
string ,
clusterArmId:
{
Description: Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Failover (removed)
Description :  GeoDR Failover
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/failover
{
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 ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for updating a namespace resource. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
primaryLocation:
{
Description: Query parameter for the new primary location after failover. ,
Required: False ,
}
string ,
force:
{
Description: If Force is false then graceful failover is attempted after ensuring no data loss. If Force flag is set to true, Forced failover is attempted with possible data loss. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for completion status. ,
}
string ,
location:
{
Description: URI to poll for completion status. ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials 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: A collection of private endpoint connection resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: A link for the next page of private endpoint connection resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection name ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update Status of PrivateEndPoint Connection to namespace resource. ,
Required: True ,
}
{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Properties of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
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 ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The PrivateEndpointConnection name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials 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 of the PrivateEndpointConnection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource for this Connection. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Details about the state of the connection. ,
Required: False ,
}
{
status:
{
Description: Status of the connection. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the connection state. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the Private Endpoint Connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (removed)
Description :  Gets lists of resources that supports Privatelinks.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateLinkResources
{
resourceGroupName:
{
Description: Name of the resource group within the azure subscription. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The Namespace name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials 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: A collection of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the private link resource. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
id:
{
Description: Fully qualified identifier of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: A link for the next page of private link resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfiguration_List (removed)
Description :  Gets list of current NetworkSecurityPerimeterConfiguration for Namespace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkSecurityPerimeterConfigurations
{
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: A collection of NetworkSecurityPerimeterConfigurations ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Network Security Perimeter Configuration ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of NetworkSecurityPerimeter configuration propagation ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Accepted: No description available. ,
InvalidResponse: No description available. ,
Succeeded: No description available. ,
SucceededWithIssues: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: List of Provisioning Issues if any ,
Required: False ,
}
[
{
name:
{
Description: Name of the issue ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Provisioning Issue ,
Required: False ,
}
{
issueType:
{
Description: Type of Issue ,
Required: False ,
}
string ,
description:
{
Description: Description of the issue ,
Required: False ,
}
string ,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: NetworkSecurityPerimeter related information ,
Required: False ,
}
{
id:
{
Description: Fully qualified identifier of the resource ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the resource ,
Required: False ,
}
string ,
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Information about resource association ,
Required: False ,
}
{
name:
{
Description: Name of the resource association ,
Required: False ,
}
string ,
accessMode:
{
Description: Access Mode of the resource association ,
Enum:
{
NoAssociationMode: No description available. ,
EnforcedMode: No description available. ,
LearningMode: No description available. ,
AuditMode: No description available. ,
UnspecifiedMode: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Information about current network profile ,
Required: False ,
}
{
name:
{
Description: Name of the resource ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Current access rules version ,
Required: False ,
}
string ,
accessRules:
{
Description: List of Access Rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of the resource ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource ,
Required: False ,
}
string ,
type:
{
Description: Type of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified identifier of the resource ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the resource ,
Required: False ,
}
string ,
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
isBackingResource:
{
Description: True if the EventHub namespace is backed by another Azure resource and not visible to end users. ,
Required: False ,
}
boolean ,
applicableFeatures:
{
Description: Indicates that the NSP controls related to backing association are only applicable to a specific feature in backing resource's data plane. ,
Required: False ,
}
[
string ,
]
,
parentAssociationName:
{
Description: Source Resource Association name ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: ARM Id of source resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfigurations_CreateOrUpdate (removed)
Description :  Refreshes any information about the association.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkSecurityPerimeterConfigurations/{resourceAssociationName}/reconcile
{
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 ,
resourceAssociationName:
{
Description: The ResourceAssociation Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.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 ,
}
{
trustedServiceAccessEnabled:
{
Description: Value that indicates whether Trusted Service Access is Enabled or not. ,
Required: False ,
}
boolean ,
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: False ,
}
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: NetworkRuleSet properties ,
Required: False ,
}
{
trustedServiceAccessEnabled:
{
Description: Value that indicates whether Trusted Service Access is Enabled or not. ,
Required: False ,
}
boolean ,
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: False ,
}
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
trustedServiceAccessEnabled:
{
Description: Value that indicates whether Trusted Service Access is Enabled or not. ,
Required: False ,
}
boolean ,
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: False ,
}
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListNetworkRuleSet (removed)
Description :  Gets 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 ,
}
{
trustedServiceAccessEnabled:
{
Description: Value that indicates whether Trusted Service Access is Enabled or not. ,
Required: False ,
}
boolean ,
defaultAction:
{
Description: Default Action for Network Rule Set ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkRules:
{
Description: List VirtualNetwork Rules ,
Required: False ,
}
[
{
subnet:
{
Description: Subnet properties ,
Required: False ,
}
{
id:
{
Description: Resource ID of Virtual Network Subnet ,
Required: False ,
}
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 ,
}
,
]
,
publicNetworkAccess:
{
Description: This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of NetworkRuleSet. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  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 ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Description: Display of the operation ,
Required: False ,
}
{
provider:
{
Description: Resource provider of the operation ,
Required: False ,
}
string ,
resource:
{
Description: Resource of the operation ,
Required: False ,
}
string ,
operation:
{
Description: Localized friendly name for the operation ,
Required: False ,
}
string ,
description:
{
Description: Localized friendly description for the operation ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the operation ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configuration_Patch (removed)
Description :  Replace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/quotaConfiguration/default
{
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 ,
clusterName:
{
Description: The name of the Event Hubs Cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for creating an Event Hubs Cluster resource. ,
Required: True ,
}
{
settings:
{
Description: All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster. ,
Required: True ,
}
object ,
}
,
}

⚐ Response (200)

{
settings:
{
Description: All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
settings:
{
Description: All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configuration_Get (removed)
Description :  Get all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/quotaConfiguration/default
{
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 ,
clusterName:
{
Description: The name of the Event Hubs Cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
settings:
{
Description: All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster. ,
Required: False ,
}
object ,
}

⚐ Response (default)

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