Microsoft.EventHub-naamruimten/eventhubs 2024-05-01-preview
Bicep-resourcedefinitie
Het resourcetype naamruimten/eventhubs kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource microsoft.EventHub/naamruimten/eventhubs wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.EventHub/namespaces/eventhubs@2024-05-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
captureDescription: {
destination: {
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
name: 'string'
properties: {
archiveNameFormat: 'string'
blobContainer: 'string'
dataLakeAccountName: 'string'
dataLakeFolderPath: 'string'
dataLakeSubscriptionId: 'string'
storageAccountResourceId: 'string'
}
}
enabled: bool
encoding: 'string'
intervalInSeconds: int
sizeLimitInBytes: int
skipEmptyArchives: bool
}
messageRetentionInDays: int
messageTimestampDescription: {
timestampType: 'string'
}
partitionCount: int
retentionDescription: {
cleanupPolicy: 'string'
minCompactionLagInMins: int
retentionTimeInHours: int
tombstoneRetentionTimeInHours: int
}
status: 'string'
userMetadata: 'string'
}
}
Eigenschapswaarden
CaptureDescription
Naam | Beschrijving | Waarde |
---|---|---|
bestemming | Eigenschappen van bestemming waar vastleggen wordt opgeslagen. (Opslagaccount, blobnamen) | doel- |
Ingeschakeld | Een waarde die aangeeft of de beschrijving van het vastleggen is ingeschakeld. | Bool |
codering | Inventariseert de mogelijke waarden voor de coderingsindeling van de capture-beschrijving. Opmerking: AvroDeflate wordt afgeschaft in de nieuwe API-versie | 'Avro' 'AvroDeflate' |
intervalInSeconds | In het tijdvenster kunt u de frequentie instellen waarmee de opname naar Azure Blobs plaatsvindt, de waarde moet tussen 60 en 900 seconden bedragen | Int |
sizeLimitInBytes | Het groottevenster definieert de hoeveelheid gegevens die zijn opgebouwd in uw Event Hub voordat een opnamebewerking wordt uitgevoerd. De waarde moet tussen 10485760 tot 524288000 bytes zijn | Int |
skipEmptyArchives | Een waarde die aangeeft of lege archieven moeten worden overgeslagen | Bool |
CaptureIdentity
Naam | Beschrijving | Waarde |
---|---|---|
type | Type beheerde identiteit van Azure Active Directory. | 'SystemAssigned' UserAssigned |
userAssignedIdentity | ARM-id van beheerde gebruikersidentiteit. Deze eigenschap is vereist, is het type UserAssignedIdentity. Als het type SystemAssigned is, wordt de door het systeem toegewezen identiteit gebruikt die is gekoppeld aan de naamruimte. | snaar |
Bestemming
Naam | Beschrijving | Waarde |
---|---|---|
identiteit | Een waarde die aangeeft of de beschrijving van het vastleggen is ingeschakeld. | CaptureIdentity- |
naam | Naam voor capture-bestemming | snaar |
Eigenschappen | Eigenschappen van het opslagaccount, de blobcontainer en de archiefnaamindeling voor het vastleggen van de bestemming | DestinationProperties- |
DestinationProperties
Naam | Beschrijving | Waarde |
---|---|---|
archiveNameFormat | Naamconventie voor blob voor archief, bijvoorbeeld {Naamruimte}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Hier zijn alle parameters (naamruimte, EventHub enzovoort) verplicht, ongeacht de volgorde | snaar |
blobContainer | Naam van blobcontainer | snaar |
dataLakeAccountName | De azure Data Lake Store-naam voor de vastgelegde gebeurtenissen | snaar |
dataLakeFolderPath | Het pad naar de doelmap voor de vastgelegde gebeurtenissen | snaar |
dataLakeSubscriptionId | Abonnements-id van Azure Data Lake Store | snaar Beperkingen: Minimale lengte = 36 Maximale lengte = 36 Patroon = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
storageAccountResourceId | Resource-id van het opslagaccount dat moet worden gebruikt om de blobs te maken | snaar |
EventhubProperties
Naam | Beschrijving | Waarde |
---|---|---|
captureDescription | Eigenschappen van de beschrijving van het vastleggen | CaptureDescription- |
messageRetentionInDays | Aantal dagen dat de gebeurtenissen voor deze Event Hub moeten worden bewaard, moet de waarde 1 tot 7 dagen zijn | Int Beperkingen: Minimumwaarde = 1 |
messageTimestampDescription | Eigenschappen van MessageTimestamp Description | MessageTimestampDescription- |
partitionCount | Het aantal partities dat is gemaakt voor de Event Hub, toegestane waarden zijn van 1 tot 32 partities. | Int Beperkingen: Minimumwaarde = 1 |
retentionDescription | Retentie-instellingen voor Event Hub | RetentionDescription- |
status | Inventariseert de mogelijke waarden voor de status van de Event Hub. | 'Actief' 'Maken' 'Verwijderen' 'Uitgeschakeld' 'ReceiveDisabled' 'Naam wijzigen' 'Herstellen' 'SendDisabled' 'Onbekend' |
userMetadata | Hiermee worden metagegevens van de gebruiker opgeslagen en ingesteld. | snaar |
MessageTimestampDescription
Naam | Beschrijving | Waarde |
---|---|---|
timestampType | Geeft het type tijdstempel aan dat het bericht vasthoudt. Twee typen tijdstempeltypen: 'AppendTime' en 'CreateTime'. AppendTime verwijst naar de tijd waarin het bericht is toegevoegd in het brokerlogboek. CreateTime verwijst naar de tijd waarin het bericht is gegenereerd aan de bronzijde en producenten kunnen deze tijdstempel instellen tijdens het verzenden van het bericht. De standaardwaarde is AppendTime. Als u het AMQP-protocol gebruikt, is CreateTime gelijk aan AppendTime en blijft het gedrag ervan hetzelfde. | 'Maken' 'LogAppend' |
Microsoft.EventHub/naamruimten/eventhubs
Naam | Beschrijving | Waarde |
---|---|---|
naam | De resourcenaam | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 256 (vereist) |
ouder | In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd. Zie onderliggende resource buiten de bovenliggende resourcevoor meer informatie. |
Symbolische naam voor resource van het type: naamruimten |
Eigenschappen | Eigenschappen die zijn opgegeven bij de bewerking Event Hub maken of bijwerken. | EventhubProperties- |
RetentionDescription
Naam | Beschrijving | Waarde |
---|---|---|
cleanupPolicy | Inventariseert de mogelijke waarden voor het opschonen van beleid | 'Compact' 'Verwijderen' 'DeleteOrCompact' |
minCompactionLagInMins | De minimale tijd dat een bericht niet in aanmerking komt voor compressie in het logboek. Deze waarde wordt gebruikt wanneer cleanupPolicy Compact of DeleteOrCompact is. | Int |
retentionTimeInHours | Aantal uren dat de gebeurtenissen voor deze Event Hub moeten worden bewaard. Dit moet een positieve waarde zijn tot maximaal de naamruimte-SKU. -1 is een speciaal geval waarin de bewaartijd oneindig is, maar de grootte van een entiteit wordt beperkt en de grootte ervan is afhankelijk van het type naamruimte-SKU. | Int |
tombstoneRetentionTimeInHours | Aantal uren voor het bewaren van de tombstone-markeringen van een gecomprimeerde Event Hub. Deze waarde wordt gebruikt wanneer cleanupPolicy Compact of DeleteOrCompact is. De consument moet de tombstone-markering binnen deze opgegeven tijd voltooien als de consument begint vanaf het beginpunt om ervoor te zorgen dat deze een geldige momentopname krijgt voor de specifieke sleutel die wordt beschreven door de tombstone-markering in de gecomprimeerde Event Hub | Int |
Quickstart-voorbeelden
In de volgende quickstartvoorbeelden wordt dit resourcetype geïmplementeerd.
Bicep-bestand | Beschrijving |
---|---|
Azure Digital Twins met Time Data History Connection | Met deze sjabloon maakt u een Azure Digital Twins-exemplaar dat is geconfigureerd met een tijdreeksgegevensgeschiedenisverbinding. Als u een verbinding wilt maken, moeten andere resources worden gemaakt, zoals een Event Hubs-naamruimte, een Event Hub, een Azure Data Explorer-cluster en een database. Gegevens worden verzonden naar een Event Hub die de gegevens uiteindelijk doorstuurt naar het Azure Data Explorer-cluster. Gegevens worden opgeslagen in een databasetabel in het cluster |
Azure-functie-app met Event Hub en Beheerde identiteit | zijn sjabloon richt een Azure Function-app in op een Linux Consumption-abonnement, samen met een Event Hub, Azure Storage en Application Insights. De functie-app kan beheerde identiteit gebruiken om verbinding te maken met het Event Hub- en Storage-account |
Een Event Hub- maken | Met deze sjabloon kunt u een EventHubs-naamruimte implementeren met een Event Hub. |
Een EventHubs-naamruimte, Event Hub, & consumentengroep maken | Met deze sjabloon kunt u een Event Hubs Standard-naamruimte, een Event Hub en een consumentengroep implementeren. |
Maakt eventhub-cluster, naamsapce & eventhub- | Met deze sjabloon kunt u EventHubs-cluster, naamruimte en eventhub maken in het cluster |
Azure Data Explorer-database implementeren met Event Grid-verbinding | Azure Data Explorer-database implementeren met Event Grid-verbinding. |
Azure Data Explorer-database implementeren met Event Hub-verbinding | Azure Data Explorer-database implementeren met Event Hub-verbinding. |
De MedTech-service implementeren | De MedTech-service is een van de Azure Health Data Services die is ontworpen voor het opnemen van apparaatgegevens van meerdere apparaten, het transformeren van de apparaatgegevens naar FHIR Observations, die vervolgens worden bewaard in de Azure Health Data Services FHIR-service. |
De MedTech-service implementeren, inclusief een Azure IoT Hub- | De MedTech-service is een van de Azure Health Data Services die is ontworpen voor het opnemen van apparaatgegevens van meerdere apparaten, het transformeren van de apparaatgegevens naar FHIR Observations, die vervolgens worden bewaard in de Azure Health Data Services FHIR-service. |
Sports Analytics implementeren in Azure Architecture | Hiermee maakt u een Azure-opslagaccount waarvoor ADLS Gen 2 is ingeschakeld, een Azure Data Factory-exemplaar met gekoppelde services voor het opslagaccount (een Azure SQL Database indien geïmplementeerd) en een Azure Databricks-exemplaar. De AAD-identiteit voor de gebruiker die de sjabloon implementeert en de beheerde identiteit voor het ADF-exemplaar krijgt de rol Inzender voor opslagblobgegevens in het opslagaccount. Er zijn ook opties voor het implementeren van een Azure Key Vault-exemplaar, een Azure SQL Database en een Azure Event Hub (voor gebruiksvoorbeelden voor streaming). Wanneer een Azure Key Vault wordt geïmplementeerd, krijgen de door data factory beheerde identiteit en de AAD-identiteit voor de gebruiker die de sjabloon implementeert, de rol Key Vault Secrets User toegewezen. |
FrontDoor CDN met WAF, domeinen en logboeken naar EventHub | Met deze sjabloon maakt u een nieuw Azure FrontDoor cdn-profiel. Maak WAF met aangepaste en beheerde regels, cdn-routes, oorsprong en groepen met hun koppeling met WAF en routes, configureert aangepaste domeinen, maakt event hub en diagnostische instellingen voor het verzenden van CDN-toegangslogboeken met behulp van Event Hub. |
Moesif API Analytics and Monetization | Met de sjabloon worden API-aanroepen van Azure API Management vastgelegd naar het Moesif API-analyse- en inkomstenplatform |
Resourcedefinitie van ARM-sjabloon
Het resourcetype naamruimten/eventhubs kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource microsoft.EventHub/naamruimten/eventhubs wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"type": "Microsoft.EventHub/namespaces/eventhubs",
"apiVersion": "2024-05-01-preview",
"name": "string",
"properties": {
"captureDescription": {
"destination": {
"identity": {
"type": "string",
"userAssignedIdentity": "string"
},
"name": "string",
"properties": {
"archiveNameFormat": "string",
"blobContainer": "string",
"dataLakeAccountName": "string",
"dataLakeFolderPath": "string",
"dataLakeSubscriptionId": "string",
"storageAccountResourceId": "string"
}
},
"enabled": "bool",
"encoding": "string",
"intervalInSeconds": "int",
"sizeLimitInBytes": "int",
"skipEmptyArchives": "bool"
},
"messageRetentionInDays": "int",
"messageTimestampDescription": {
"timestampType": "string"
},
"partitionCount": "int",
"retentionDescription": {
"cleanupPolicy": "string",
"minCompactionLagInMins": "int",
"retentionTimeInHours": "int",
"tombstoneRetentionTimeInHours": "int"
},
"status": "string",
"userMetadata": "string"
}
}
Eigenschapswaarden
CaptureDescription
Naam | Beschrijving | Waarde |
---|---|---|
bestemming | Eigenschappen van bestemming waar vastleggen wordt opgeslagen. (Opslagaccount, blobnamen) | doel- |
Ingeschakeld | Een waarde die aangeeft of de beschrijving van het vastleggen is ingeschakeld. | Bool |
codering | Inventariseert de mogelijke waarden voor de coderingsindeling van de capture-beschrijving. Opmerking: AvroDeflate wordt afgeschaft in de nieuwe API-versie | 'Avro' 'AvroDeflate' |
intervalInSeconds | In het tijdvenster kunt u de frequentie instellen waarmee de opname naar Azure Blobs plaatsvindt, de waarde moet tussen 60 en 900 seconden bedragen | Int |
sizeLimitInBytes | Het groottevenster definieert de hoeveelheid gegevens die zijn opgebouwd in uw Event Hub voordat een opnamebewerking wordt uitgevoerd. De waarde moet tussen 10485760 tot 524288000 bytes zijn | Int |
skipEmptyArchives | Een waarde die aangeeft of lege archieven moeten worden overgeslagen | Bool |
CaptureIdentity
Naam | Beschrijving | Waarde |
---|---|---|
type | Type beheerde identiteit van Azure Active Directory. | 'SystemAssigned' UserAssigned |
userAssignedIdentity | ARM-id van beheerde gebruikersidentiteit. Deze eigenschap is vereist, is het type UserAssignedIdentity. Als het type SystemAssigned is, wordt de door het systeem toegewezen identiteit gebruikt die is gekoppeld aan de naamruimte. | snaar |
Bestemming
Naam | Beschrijving | Waarde |
---|---|---|
identiteit | Een waarde die aangeeft of de beschrijving van het vastleggen is ingeschakeld. | CaptureIdentity- |
naam | Naam voor capture-bestemming | snaar |
Eigenschappen | Eigenschappen van het opslagaccount, de blobcontainer en de archiefnaamindeling voor het vastleggen van de bestemming | DestinationProperties- |
DestinationProperties
Naam | Beschrijving | Waarde |
---|---|---|
archiveNameFormat | Naamconventie voor blob voor archief, bijvoorbeeld {Naamruimte}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Hier zijn alle parameters (naamruimte, EventHub enzovoort) verplicht, ongeacht de volgorde | snaar |
blobContainer | Naam van blobcontainer | snaar |
dataLakeAccountName | De azure Data Lake Store-naam voor de vastgelegde gebeurtenissen | snaar |
dataLakeFolderPath | Het pad naar de doelmap voor de vastgelegde gebeurtenissen | snaar |
dataLakeSubscriptionId | Abonnements-id van Azure Data Lake Store | snaar Beperkingen: Minimale lengte = 36 Maximale lengte = 36 Patroon = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
storageAccountResourceId | Resource-id van het opslagaccount dat moet worden gebruikt om de blobs te maken | snaar |
EventhubProperties
Naam | Beschrijving | Waarde |
---|---|---|
captureDescription | Eigenschappen van de beschrijving van het vastleggen | CaptureDescription- |
messageRetentionInDays | Aantal dagen dat de gebeurtenissen voor deze Event Hub moeten worden bewaard, moet de waarde 1 tot 7 dagen zijn | Int Beperkingen: Minimumwaarde = 1 |
messageTimestampDescription | Eigenschappen van MessageTimestamp Description | MessageTimestampDescription- |
partitionCount | Het aantal partities dat is gemaakt voor de Event Hub, toegestane waarden zijn van 1 tot 32 partities. | Int Beperkingen: Minimumwaarde = 1 |
retentionDescription | Retentie-instellingen voor Event Hub | RetentionDescription- |
status | Inventariseert de mogelijke waarden voor de status van de Event Hub. | 'Actief' 'Maken' 'Verwijderen' 'Uitgeschakeld' 'ReceiveDisabled' 'Naam wijzigen' 'Herstellen' 'SendDisabled' 'Onbekend' |
userMetadata | Hiermee worden metagegevens van de gebruiker opgeslagen en ingesteld. | snaar |
MessageTimestampDescription
Naam | Beschrijving | Waarde |
---|---|---|
timestampType | Geeft het type tijdstempel aan dat het bericht vasthoudt. Twee typen tijdstempeltypen: 'AppendTime' en 'CreateTime'. AppendTime verwijst naar de tijd waarin het bericht is toegevoegd in het brokerlogboek. CreateTime verwijst naar de tijd waarin het bericht is gegenereerd aan de bronzijde en producenten kunnen deze tijdstempel instellen tijdens het verzenden van het bericht. De standaardwaarde is AppendTime. Als u het AMQP-protocol gebruikt, is CreateTime gelijk aan AppendTime en blijft het gedrag ervan hetzelfde. | 'Maken' 'LogAppend' |
Microsoft.EventHub/naamruimten/eventhubs
Naam | Beschrijving | Waarde |
---|---|---|
apiVersion | De API-versie | '2024-05-01-preview' |
naam | De resourcenaam | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 256 (vereist) |
Eigenschappen | Eigenschappen die zijn opgegeven bij de bewerking Event Hub maken of bijwerken. | EventhubProperties- |
type | Het resourcetype | 'Microsoft.EventHub/namespaces/eventhubs' |
RetentionDescription
Naam | Beschrijving | Waarde |
---|---|---|
cleanupPolicy | Inventariseert de mogelijke waarden voor het opschonen van beleid | 'Compact' 'Verwijderen' 'DeleteOrCompact' |
minCompactionLagInMins | De minimale tijd dat een bericht niet in aanmerking komt voor compressie in het logboek. Deze waarde wordt gebruikt wanneer cleanupPolicy Compact of DeleteOrCompact is. | Int |
retentionTimeInHours | Aantal uren dat de gebeurtenissen voor deze Event Hub moeten worden bewaard. Dit moet een positieve waarde zijn tot maximaal de naamruimte-SKU. -1 is een speciaal geval waarin de bewaartijd oneindig is, maar de grootte van een entiteit wordt beperkt en de grootte ervan is afhankelijk van het type naamruimte-SKU. | Int |
tombstoneRetentionTimeInHours | Aantal uren voor het bewaren van de tombstone-markeringen van een gecomprimeerde Event Hub. Deze waarde wordt gebruikt wanneer cleanupPolicy Compact of DeleteOrCompact is. De consument moet de tombstone-markering binnen deze opgegeven tijd voltooien als de consument begint vanaf het beginpunt om ervoor te zorgen dat deze een geldige momentopname krijgt voor de specifieke sleutel die wordt beschreven door de tombstone-markering in de gecomprimeerde Event Hub | Int |
Quickstart-sjablonen
Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.
Sjabloon | Beschrijving |
---|---|
Azure Digital Twins met Time Data History Connection |
Met deze sjabloon maakt u een Azure Digital Twins-exemplaar dat is geconfigureerd met een tijdreeksgegevensgeschiedenisverbinding. Als u een verbinding wilt maken, moeten andere resources worden gemaakt, zoals een Event Hubs-naamruimte, een Event Hub, een Azure Data Explorer-cluster en een database. Gegevens worden verzonden naar een Event Hub die de gegevens uiteindelijk doorstuurt naar het Azure Data Explorer-cluster. Gegevens worden opgeslagen in een databasetabel in het cluster |
Azure-functie-app met Event Hub en Beheerde identiteit |
zijn sjabloon richt een Azure Function-app in op een Linux Consumption-abonnement, samen met een Event Hub, Azure Storage en Application Insights. De functie-app kan beheerde identiteit gebruiken om verbinding te maken met het Event Hub- en Storage-account |
Een Event Hub- maken |
Met deze sjabloon kunt u een EventHubs-naamruimte implementeren met een Event Hub. |
Een EventHubs-naamruimte, Event Hub, & consumentengroep maken |
Met deze sjabloon kunt u een Event Hubs Standard-naamruimte, een Event Hub en een consumentengroep implementeren. |
Maakt eventhub-cluster, naamsapce & eventhub- |
Met deze sjabloon kunt u EventHubs-cluster, naamruimte en eventhub maken in het cluster |
Azure Data Explorer-database implementeren met Event Grid-verbinding |
Azure Data Explorer-database implementeren met Event Grid-verbinding. |
Azure Data Explorer-database implementeren met Event Hub-verbinding |
Azure Data Explorer-database implementeren met Event Hub-verbinding. |
De MedTech-service implementeren |
De MedTech-service is een van de Azure Health Data Services die is ontworpen voor het opnemen van apparaatgegevens van meerdere apparaten, het transformeren van de apparaatgegevens naar FHIR Observations, die vervolgens worden bewaard in de Azure Health Data Services FHIR-service. |
De MedTech-service implementeren, inclusief een Azure IoT Hub- |
De MedTech-service is een van de Azure Health Data Services die is ontworpen voor het opnemen van apparaatgegevens van meerdere apparaten, het transformeren van de apparaatgegevens naar FHIR Observations, die vervolgens worden bewaard in de Azure Health Data Services FHIR-service. |
Sports Analytics implementeren in Azure Architecture |
Hiermee maakt u een Azure-opslagaccount waarvoor ADLS Gen 2 is ingeschakeld, een Azure Data Factory-exemplaar met gekoppelde services voor het opslagaccount (een Azure SQL Database indien geïmplementeerd) en een Azure Databricks-exemplaar. De AAD-identiteit voor de gebruiker die de sjabloon implementeert en de beheerde identiteit voor het ADF-exemplaar krijgt de rol Inzender voor opslagblobgegevens in het opslagaccount. Er zijn ook opties voor het implementeren van een Azure Key Vault-exemplaar, een Azure SQL Database en een Azure Event Hub (voor gebruiksvoorbeelden voor streaming). Wanneer een Azure Key Vault wordt geïmplementeerd, krijgen de door data factory beheerde identiteit en de AAD-identiteit voor de gebruiker die de sjabloon implementeert, de rol Key Vault Secrets User toegewezen. |
FrontDoor CDN met WAF, domeinen en logboeken naar EventHub |
Met deze sjabloon maakt u een nieuw Azure FrontDoor cdn-profiel. Maak WAF met aangepaste en beheerde regels, cdn-routes, oorsprong en groepen met hun koppeling met WAF en routes, configureert aangepaste domeinen, maakt event hub en diagnostische instellingen voor het verzenden van CDN-toegangslogboeken met behulp van Event Hub. |
Moesif API Analytics and Monetization |
Met de sjabloon worden API-aanroepen van Azure API Management vastgelegd naar het Moesif API-analyse- en inkomstenplatform |
Resourcedefinitie van Terraform (AzAPI-provider)
Het resourcetype naamruimten/eventhubs kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource microsoft.EventHub/naamruimten/eventhubs wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventHub/namespaces/eventhubs@2024-05-01-preview"
name = "string"
body = jsonencode({
properties = {
captureDescription = {
destination = {
identity = {
type = "string"
userAssignedIdentity = "string"
}
name = "string"
properties = {
archiveNameFormat = "string"
blobContainer = "string"
dataLakeAccountName = "string"
dataLakeFolderPath = "string"
dataLakeSubscriptionId = "string"
storageAccountResourceId = "string"
}
}
enabled = bool
encoding = "string"
intervalInSeconds = int
sizeLimitInBytes = int
skipEmptyArchives = bool
}
messageRetentionInDays = int
messageTimestampDescription = {
timestampType = "string"
}
partitionCount = int
retentionDescription = {
cleanupPolicy = "string"
minCompactionLagInMins = int
retentionTimeInHours = int
tombstoneRetentionTimeInHours = int
}
status = "string"
userMetadata = "string"
}
})
}
Eigenschapswaarden
CaptureDescription
Naam | Beschrijving | Waarde |
---|---|---|
bestemming | Eigenschappen van bestemming waar vastleggen wordt opgeslagen. (Opslagaccount, blobnamen) | doel- |
Ingeschakeld | Een waarde die aangeeft of de beschrijving van het vastleggen is ingeschakeld. | Bool |
codering | Inventariseert de mogelijke waarden voor de coderingsindeling van de capture-beschrijving. Opmerking: AvroDeflate wordt afgeschaft in de nieuwe API-versie | 'Avro' 'AvroDeflate' |
intervalInSeconds | In het tijdvenster kunt u de frequentie instellen waarmee de opname naar Azure Blobs plaatsvindt, de waarde moet tussen 60 en 900 seconden bedragen | Int |
sizeLimitInBytes | Het groottevenster definieert de hoeveelheid gegevens die zijn opgebouwd in uw Event Hub voordat een opnamebewerking wordt uitgevoerd. De waarde moet tussen 10485760 tot 524288000 bytes zijn | Int |
skipEmptyArchives | Een waarde die aangeeft of lege archieven moeten worden overgeslagen | Bool |
CaptureIdentity
Naam | Beschrijving | Waarde |
---|---|---|
type | Type beheerde identiteit van Azure Active Directory. | 'SystemAssigned' UserAssigned |
userAssignedIdentity | ARM-id van beheerde gebruikersidentiteit. Deze eigenschap is vereist, is het type UserAssignedIdentity. Als het type SystemAssigned is, wordt de door het systeem toegewezen identiteit gebruikt die is gekoppeld aan de naamruimte. | snaar |
Bestemming
Naam | Beschrijving | Waarde |
---|---|---|
identiteit | Een waarde die aangeeft of de beschrijving van het vastleggen is ingeschakeld. | CaptureIdentity- |
naam | Naam voor capture-bestemming | snaar |
Eigenschappen | Eigenschappen van het opslagaccount, de blobcontainer en de archiefnaamindeling voor het vastleggen van de bestemming | DestinationProperties- |
DestinationProperties
Naam | Beschrijving | Waarde |
---|---|---|
archiveNameFormat | Naamconventie voor blob voor archief, bijvoorbeeld {Naamruimte}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Hier zijn alle parameters (naamruimte, EventHub enzovoort) verplicht, ongeacht de volgorde | snaar |
blobContainer | Naam van blobcontainer | snaar |
dataLakeAccountName | De azure Data Lake Store-naam voor de vastgelegde gebeurtenissen | snaar |
dataLakeFolderPath | Het pad naar de doelmap voor de vastgelegde gebeurtenissen | snaar |
dataLakeSubscriptionId | Abonnements-id van Azure Data Lake Store | snaar Beperkingen: Minimale lengte = 36 Maximale lengte = 36 Patroon = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
storageAccountResourceId | Resource-id van het opslagaccount dat moet worden gebruikt om de blobs te maken | snaar |
EventhubProperties
Naam | Beschrijving | Waarde |
---|---|---|
captureDescription | Eigenschappen van de beschrijving van het vastleggen | CaptureDescription- |
messageRetentionInDays | Aantal dagen dat de gebeurtenissen voor deze Event Hub moeten worden bewaard, moet de waarde 1 tot 7 dagen zijn | Int Beperkingen: Minimumwaarde = 1 |
messageTimestampDescription | Eigenschappen van MessageTimestamp Description | MessageTimestampDescription- |
partitionCount | Het aantal partities dat is gemaakt voor de Event Hub, toegestane waarden zijn van 1 tot 32 partities. | Int Beperkingen: Minimumwaarde = 1 |
retentionDescription | Retentie-instellingen voor Event Hub | RetentionDescription- |
status | Inventariseert de mogelijke waarden voor de status van de Event Hub. | 'Actief' 'Maken' 'Verwijderen' 'Uitgeschakeld' 'ReceiveDisabled' 'Naam wijzigen' 'Herstellen' 'SendDisabled' 'Onbekend' |
userMetadata | Hiermee worden metagegevens van de gebruiker opgeslagen en ingesteld. | snaar |
MessageTimestampDescription
Naam | Beschrijving | Waarde |
---|---|---|
timestampType | Geeft het type tijdstempel aan dat het bericht vasthoudt. Twee typen tijdstempeltypen: 'AppendTime' en 'CreateTime'. AppendTime verwijst naar de tijd waarin het bericht is toegevoegd in het brokerlogboek. CreateTime verwijst naar de tijd waarin het bericht is gegenereerd aan de bronzijde en producenten kunnen deze tijdstempel instellen tijdens het verzenden van het bericht. De standaardwaarde is AppendTime. Als u het AMQP-protocol gebruikt, is CreateTime gelijk aan AppendTime en blijft het gedrag ervan hetzelfde. | 'Maken' 'LogAppend' |
Microsoft.EventHub/naamruimten/eventhubs
Naam | Beschrijving | Waarde |
---|---|---|
naam | De resourcenaam | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 256 (vereist) |
parent_id | De id van de resource die het bovenliggende item voor deze resource is. | Id voor resource van het type: naamruimten |
Eigenschappen | Eigenschappen die zijn opgegeven bij de bewerking Event Hub maken of bijwerken. | EventhubProperties- |
type | Het resourcetype | "Microsoft.EventHub/namespaces/eventhubs@2024-05-01-preview" |
RetentionDescription
Naam | Beschrijving | Waarde |
---|---|---|
cleanupPolicy | Inventariseert de mogelijke waarden voor het opschonen van beleid | 'Compact' 'Verwijderen' 'DeleteOrCompact' |
minCompactionLagInMins | De minimale tijd dat een bericht niet in aanmerking komt voor compressie in het logboek. Deze waarde wordt gebruikt wanneer cleanupPolicy Compact of DeleteOrCompact is. | Int |
retentionTimeInHours | Aantal uren dat de gebeurtenissen voor deze Event Hub moeten worden bewaard. Dit moet een positieve waarde zijn tot maximaal de naamruimte-SKU. -1 is een speciaal geval waarin de bewaartijd oneindig is, maar de grootte van een entiteit wordt beperkt en de grootte ervan is afhankelijk van het type naamruimte-SKU. | Int |
tombstoneRetentionTimeInHours | Aantal uren voor het bewaren van de tombstone-markeringen van een gecomprimeerde Event Hub. Deze waarde wordt gebruikt wanneer cleanupPolicy Compact of DeleteOrCompact is. De consument moet de tombstone-markering binnen deze opgegeven tijd voltooien als de consument begint vanaf het beginpunt om ervoor te zorgen dat deze een geldige momentopname krijgt voor de specifieke sleutel die wordt beschreven door de tombstone-markering in de gecomprimeerde Event Hub | Int |