eventhub.azure.com/v1api20240101
APIVersion
| Value | Description |
|---|---|
| “2024-01-01” |
Namespace
Generator information: - Generated from: /eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/namespaces.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}
Used by: NamespaceList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Namespace_Spec Optional |
|
| status | Namespace_STATUS Optional |
Namespace_Spec
| Property | Description | Type |
|---|---|---|
| alternateName | Alternate name specified when alias and namespace names are same. | string Optional |
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| clusterArmReference | Cluster ARM ID of the Namespace. | genruntime.ResourceReference Optional |
| disableLocalAuth | This property disables SAS authentication for the Event Hubs namespace. | bool Optional |
| encryption | Properties of BYOK Encryption description | Encryption Optional |
| identity | Properties of BYOK Identity description | Identity Optional |
| isAutoInflateEnabled | Value that indicates whether AutoInflate is enabled for eventhub namespace. | bool Optional |
| kafkaEnabled | Value that indicates whether Kafka is enabled for eventhub namespace. | bool Optional |
| location | Resource location. | string Optional |
| maximumThroughputUnits | Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( ‘0’ if AutoInflateEnabled = true) | int Optional |
| minimumTlsVersion | The minimum TLS version for the cluster to support, e.g. ‘1.2’ | Namespace_Properties_MinimumTlsVersion_Spec Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespaceOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| publicNetworkAccess | This determines if traffic is allowed over public network. By default it is enabled. | Namespace_Properties_PublicNetworkAccess_Spec Optional |
| sku | Properties of sku resource | Sku Optional |
| tags | Resource tags. | map[string]string Optional |
| zoneRedundant | Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. | bool Optional |
Namespace_STATUS
| Property | Description | Type |
|---|---|---|
| alternateName | Alternate name specified when alias and namespace names are same. | string Optional |
| clusterArmId | Cluster ARM ID of the Namespace. | string Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| createdAt | The time the Namespace was created. | string Optional |
| disableLocalAuth | This property disables SAS authentication for the Event Hubs namespace. | bool Optional |
| encryption | Properties of BYOK Encryption description | Encryption_STATUS Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | Properties of BYOK Identity description | Identity_STATUS Optional |
| isAutoInflateEnabled | Value that indicates whether AutoInflate is enabled for eventhub namespace. | bool Optional |
| kafkaEnabled | Value that indicates whether Kafka is enabled for eventhub namespace. | bool Optional |
| location | Resource location. | string Optional |
| maximumThroughputUnits | Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( ‘0’ if AutoInflateEnabled = true) | int Optional |
| metricId | Identifier for Azure Insights metrics. | string Optional |
| minimumTlsVersion | The minimum TLS version for the cluster to support, e.g. ‘1.2’ | Namespace_Properties_MinimumTlsVersion_STATUS Optional |
| name | The name of the resource | string Optional |
| privateEndpointConnections | List of private endpoint connections. | PrivateEndpointConnection_STATUS[] Optional |
| provisioningState | Provisioning state of the Namespace. | string Optional |
| publicNetworkAccess | This determines if traffic is allowed over public network. By default it is enabled. | Namespace_Properties_PublicNetworkAccess_STATUS Optional |
| serviceBusEndpoint | Endpoint you can use to perform Service Bus operations. | string Optional |
| sku | Properties of sku resource | Sku_STATUS Optional |
| status | Status of the Namespace. | string Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| updatedAt | The time the Namespace was updated. | string Optional |
| zoneRedundant | Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. | bool Optional |
NamespaceList
Generator information: - Generated from: /eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/namespaces.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Namespace[] Optional |
NamespacesAuthorizationRule
Generator information: - Generated from: /eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/AuthorizationRules.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
Used by: NamespacesAuthorizationRuleList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | NamespacesAuthorizationRule_Spec Optional |
|
| status | NamespacesAuthorizationRule_STATUS Optional |
NamespacesAuthorizationRule_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespacesAuthorizationRuleOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a eventhub.azure.com/Namespace resource | genruntime.KnownResourceReference Required |
| rights | The rights associated with the rule. | Namespaces_AuthorizationRule_Properties_Rights_Spec[] Required |
NamespacesAuthorizationRule_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| rights | The rights associated with the rule. | Namespaces_AuthorizationRule_Properties_Rights_STATUS[] Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” | string Optional |
NamespacesAuthorizationRuleList
Generator information: - Generated from: /eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/AuthorizationRules.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | NamespacesAuthorizationRule[] Optional |
NamespacesEventhub
Generator information: - Generated from: /eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/eventhubs.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}
Used by: NamespacesEventhubList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | NamespacesEventhub_Spec Optional |
|
| status | NamespacesEventhub_STATUS Optional |
NamespacesEventhub_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| captureDescription | Properties of capture description | CaptureDescription Optional |
| messageRetentionInDays | Number of days to retain the events for this Event Hub, value should be 1 to 7 days | int Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespacesEventhubOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a eventhub.azure.com/Namespace resource | genruntime.KnownResourceReference Required |
| partitionCount | Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. | int Optional |
| retentionDescription | Event Hub retention settings | RetentionDescription Optional |
| userMetadata | Gets and Sets Metadata of User. | string Optional |
NamespacesEventhub_STATUS
| Property | Description | Type |
|---|---|---|
| captureDescription | Properties of capture description | CaptureDescription_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| createdAt | Exact time the Event Hub was created. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| location | The geo-location where the resource lives | string Optional |
| messageRetentionInDays | Number of days to retain the events for this Event Hub, value should be 1 to 7 days | int Optional |
| name | The name of the resource | string Optional |
| partitionCount | Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. | int Optional |
| partitionIds | Current number of shards on the Event Hub. | string[] Optional |
| retentionDescription | Event Hub retention settings | RetentionDescription_STATUS Optional |
| status | Enumerates the possible values for the status of the Event Hub. | Namespaces_Eventhub_Properties_Status_STATUS Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” | string Optional |
| updatedAt | The exact time the message was updated. | string Optional |
| userMetadata | Gets and Sets Metadata of User. | string Optional |
NamespacesEventhubList
Generator information: - Generated from: /eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/eventhubs.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | NamespacesEventhub[] Optional |
NamespacesEventhubsAuthorizationRule
Generator information: - Generated from: /eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/AuthorizationRules.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}
Used by: NamespacesEventhubsAuthorizationRuleList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | NamespacesEventhubsAuthorizationRule_Spec Optional |
|
| status | NamespacesEventhubsAuthorizationRule_STATUS Optional |
NamespacesEventhubsAuthorizationRule_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespacesEventhubsAuthorizationRuleOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a eventhub.azure.com/NamespacesEventhub resource | genruntime.KnownResourceReference Required |
| rights | The rights associated with the rule. | Namespaces_Eventhubs_AuthorizationRule_Properties_Rights_Spec[] Required |
NamespacesEventhubsAuthorizationRule_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| rights | The rights associated with the rule. | Namespaces_Eventhubs_AuthorizationRule_Properties_Rights_STATUS[] Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” | string Optional |
NamespacesEventhubsAuthorizationRuleList
Generator information: - Generated from: /eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/AuthorizationRules.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | NamespacesEventhubsAuthorizationRule[] Optional |
NamespacesEventhubsConsumerGroup
Generator information: - Generated from: /eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/consumergroups.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}
Used by: NamespacesEventhubsConsumerGroupList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | NamespacesEventhubsConsumerGroup_Spec Optional |
|
| status | NamespacesEventhubsConsumerGroup_STATUS Optional |
NamespacesEventhubsConsumerGroup_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespacesEventhubsConsumerGroupOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a eventhub.azure.com/NamespacesEventhub resource | genruntime.KnownResourceReference Required |
| userMetadata | 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. | string Optional |
NamespacesEventhubsConsumerGroup_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| createdAt | Exact time the message was created. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” | string Optional |
| updatedAt | The exact time the message was updated. | string Optional |
| userMetadata | 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. | string Optional |
NamespacesEventhubsConsumerGroupList
Generator information: - Generated from: /eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/consumergroups.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | NamespacesEventhubsConsumerGroup[] Optional |
Namespace_Spec
Used by: Namespace.
| Property | Description | Type |
|---|---|---|
| alternateName | Alternate name specified when alias and namespace names are same. | string Optional |
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| clusterArmReference | Cluster ARM ID of the Namespace. | genruntime.ResourceReference Optional |
| disableLocalAuth | This property disables SAS authentication for the Event Hubs namespace. | bool Optional |
| encryption | Properties of BYOK Encryption description | Encryption Optional |
| identity | Properties of BYOK Identity description | Identity Optional |
| isAutoInflateEnabled | Value that indicates whether AutoInflate is enabled for eventhub namespace. | bool Optional |
| kafkaEnabled | Value that indicates whether Kafka is enabled for eventhub namespace. | bool Optional |
| location | Resource location. | string Optional |
| maximumThroughputUnits | Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( ‘0’ if AutoInflateEnabled = true) | int Optional |
| minimumTlsVersion | The minimum TLS version for the cluster to support, e.g. ‘1.2’ | Namespace_Properties_MinimumTlsVersion_Spec Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespaceOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| publicNetworkAccess | This determines if traffic is allowed over public network. By default it is enabled. | Namespace_Properties_PublicNetworkAccess_Spec Optional |
| sku | Properties of sku resource | Sku Optional |
| tags | Resource tags. | map[string]string Optional |
| zoneRedundant | Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. | bool Optional |
Namespace_STATUS
Used by: Namespace.
| Property | Description | Type |
|---|---|---|
| alternateName | Alternate name specified when alias and namespace names are same. | string Optional |
| clusterArmId | Cluster ARM ID of the Namespace. | string Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| createdAt | The time the Namespace was created. | string Optional |
| disableLocalAuth | This property disables SAS authentication for the Event Hubs namespace. | bool Optional |
| encryption | Properties of BYOK Encryption description | Encryption_STATUS Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | Properties of BYOK Identity description | Identity_STATUS Optional |
| isAutoInflateEnabled | Value that indicates whether AutoInflate is enabled for eventhub namespace. | bool Optional |
| kafkaEnabled | Value that indicates whether Kafka is enabled for eventhub namespace. | bool Optional |
| location | Resource location. | string Optional |
| maximumThroughputUnits | Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( ‘0’ if AutoInflateEnabled = true) | int Optional |
| metricId | Identifier for Azure Insights metrics. | string Optional |
| minimumTlsVersion | The minimum TLS version for the cluster to support, e.g. ‘1.2’ | Namespace_Properties_MinimumTlsVersion_STATUS Optional |
| name | The name of the resource | string Optional |
| privateEndpointConnections | List of private endpoint connections. | PrivateEndpointConnection_STATUS[] Optional |
| provisioningState | Provisioning state of the Namespace. | string Optional |
| publicNetworkAccess | This determines if traffic is allowed over public network. By default it is enabled. | Namespace_Properties_PublicNetworkAccess_STATUS Optional |
| serviceBusEndpoint | Endpoint you can use to perform Service Bus operations. | string Optional |
| sku | Properties of sku resource | Sku_STATUS Optional |
| status | Status of the Namespace. | string Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| updatedAt | The time the Namespace was updated. | string Optional |
| zoneRedundant | Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. | bool Optional |
NamespacesAuthorizationRule_Spec
Used by: NamespacesAuthorizationRule.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespacesAuthorizationRuleOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a eventhub.azure.com/Namespace resource | genruntime.KnownResourceReference Required |
| rights | The rights associated with the rule. | Namespaces_AuthorizationRule_Properties_Rights_Spec[] Required |
NamespacesAuthorizationRule_STATUS
Used by: NamespacesAuthorizationRule.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| rights | The rights associated with the rule. | Namespaces_AuthorizationRule_Properties_Rights_STATUS[] Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” | string Optional |
NamespacesEventhub_Spec
Used by: NamespacesEventhub.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| captureDescription | Properties of capture description | CaptureDescription Optional |
| messageRetentionInDays | Number of days to retain the events for this Event Hub, value should be 1 to 7 days | int Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespacesEventhubOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a eventhub.azure.com/Namespace resource | genruntime.KnownResourceReference Required |
| partitionCount | Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. | int Optional |
| retentionDescription | Event Hub retention settings | RetentionDescription Optional |
| userMetadata | Gets and Sets Metadata of User. | string Optional |
NamespacesEventhub_STATUS
Used by: NamespacesEventhub.
| Property | Description | Type |
|---|---|---|
| captureDescription | Properties of capture description | CaptureDescription_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| createdAt | Exact time the Event Hub was created. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| location | The geo-location where the resource lives | string Optional |
| messageRetentionInDays | Number of days to retain the events for this Event Hub, value should be 1 to 7 days | int Optional |
| name | The name of the resource | string Optional |
| partitionCount | Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. | int Optional |
| partitionIds | Current number of shards on the Event Hub. | string[] Optional |
| retentionDescription | Event Hub retention settings | RetentionDescription_STATUS Optional |
| status | Enumerates the possible values for the status of the Event Hub. | Namespaces_Eventhub_Properties_Status_STATUS Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” | string Optional |
| updatedAt | The exact time the message was updated. | string Optional |
| userMetadata | Gets and Sets Metadata of User. | string Optional |
NamespacesEventhubsAuthorizationRule_Spec
Used by: NamespacesEventhubsAuthorizationRule.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespacesEventhubsAuthorizationRuleOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a eventhub.azure.com/NamespacesEventhub resource | genruntime.KnownResourceReference Required |
| rights | The rights associated with the rule. | Namespaces_Eventhubs_AuthorizationRule_Properties_Rights_Spec[] Required |
NamespacesEventhubsAuthorizationRule_STATUS
Used by: NamespacesEventhubsAuthorizationRule.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| rights | The rights associated with the rule. | Namespaces_Eventhubs_AuthorizationRule_Properties_Rights_STATUS[] Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” | string Optional |
NamespacesEventhubsConsumerGroup_Spec
Used by: NamespacesEventhubsConsumerGroup.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespacesEventhubsConsumerGroupOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a eventhub.azure.com/NamespacesEventhub resource | genruntime.KnownResourceReference Required |
| userMetadata | 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. | string Optional |
NamespacesEventhubsConsumerGroup_STATUS
Used by: NamespacesEventhubsConsumerGroup.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| createdAt | Exact time the message was created. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| systemData | The system meta data relating to this resource. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” | string Optional |
| updatedAt | The exact time the message was updated. | string Optional |
| userMetadata | 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. | string Optional |
CaptureDescription
Properties to configure capture description for eventhub
Used by: NamespacesEventhub_Spec.
| Property | Description | Type |
|---|---|---|
| destination | Properties of Destination where capture will be stored. (Storage Account, Blob Names) | Destination Optional |
| enabled | A value that indicates whether capture description is enabled. | bool Optional |
| encoding | Enumerates the possible values for the encoding format of capture description. Note: ‘AvroDeflate’ will be deprecated in New API Version | CaptureDescription_Encoding Optional |
| intervalInSeconds | 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 | int Optional |
| sizeLimitInBytes | 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 | int Optional |
| skipEmptyArchives | A value that indicates whether to Skip Empty Archives | bool Optional |
CaptureDescription_STATUS
Properties to configure capture description for eventhub
Used by: NamespacesEventhub_STATUS.
| Property | Description | Type |
|---|---|---|
| destination | Properties of Destination where capture will be stored. (Storage Account, Blob Names) | Destination_STATUS Optional |
| enabled | A value that indicates whether capture description is enabled. | bool Optional |
| encoding | Enumerates the possible values for the encoding format of capture description. Note: ‘AvroDeflate’ will be deprecated in New API Version | CaptureDescription_Encoding_STATUS Optional |
| intervalInSeconds | 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 | int Optional |
| sizeLimitInBytes | 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 | int Optional |
| skipEmptyArchives | A value that indicates whether to Skip Empty Archives | bool Optional |
Encryption
Properties to configure Encryption
Used by: Namespace_Spec.
| Property | Description | Type |
|---|---|---|
| keySource | Enumerates the possible value of keySource for Encryption | Encryption_KeySource Optional |
| keyVaultProperties | Properties of KeyVault | KeyVaultProperties[] Optional |
| requireInfrastructureEncryption | Enable Infrastructure Encryption (Double Encryption) | bool Optional |
Encryption_STATUS
Properties to configure Encryption
Used by: Namespace_STATUS.
| Property | Description | Type |
|---|---|---|
| keySource | Enumerates the possible value of keySource for Encryption | Encryption_KeySource_STATUS Optional |
| keyVaultProperties | Properties of KeyVault | KeyVaultProperties_STATUS[] Optional |
| requireInfrastructureEncryption | Enable Infrastructure Encryption (Double Encryption) | bool Optional |
Identity
Properties to configure Identity for Bring your Own Keys
Used by: Namespace_Spec.
| Property | Description | Type |
|---|---|---|
| type | Type of managed service identity. | Identity_Type Optional |
| userAssignedIdentities | Properties for User Assigned Identities | UserAssignedIdentityDetails[] Optional |
Identity_STATUS
Properties to configure Identity for Bring your Own Keys
Used by: Namespace_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | ObjectId from the KeyVault | string Optional |
| tenantId | TenantId from the KeyVault | string Optional |
| type | Type of managed service identity. | Identity_Type_STATUS Optional |
| userAssignedIdentities | Properties for User Assigned Identities | map[string]UserAssignedIdentity_STATUS Optional |
Namespace_Properties_MinimumTlsVersion_Spec
Used by: Namespace_Spec.
| Value | Description |
|---|---|
| “1.0” | |
| “1.1” | |
| “1.2” |
Namespace_Properties_MinimumTlsVersion_STATUS
Used by: Namespace_STATUS.
| Value | Description |
|---|---|
| “1.0” | |
| “1.1” | |
| “1.2” |
Namespace_Properties_PublicNetworkAccess_Spec
Used by: Namespace_Spec.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” | |
| “SecuredByPerimeter” |
Namespace_Properties_PublicNetworkAccess_STATUS
Used by: Namespace_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” | |
| “SecuredByPerimeter” |
NamespaceOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Namespace_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
| secrets | configures where to place Azure generated secrets. | NamespaceOperatorSecrets Optional |
Namespaces_AuthorizationRule_Properties_Rights_Spec
Used by: NamespacesAuthorizationRule_Spec.
| Value | Description |
|---|---|
| “Listen” | |
| “Manage” | |
| “Send” |
Namespaces_AuthorizationRule_Properties_Rights_STATUS
Used by: NamespacesAuthorizationRule_STATUS.
| Value | Description |
|---|---|
| “Listen” | |
| “Manage” | |
| “Send” |
Namespaces_Eventhub_Properties_Status_STATUS
Used by: NamespacesEventhub_STATUS.
| Value | Description |
|---|---|
| “Active” | |
| “Creating” | |
| “Deleting” | |
| “Disabled” | |
| “ReceiveDisabled” | |
| “Renaming” | |
| “Restoring” | |
| “SendDisabled” | |
| “Unknown” |
Namespaces_Eventhubs_AuthorizationRule_Properties_Rights_Spec
Used by: NamespacesEventhubsAuthorizationRule_Spec.
| Value | Description |
|---|---|
| “Listen” | |
| “Manage” | |
| “Send” |
Namespaces_Eventhubs_AuthorizationRule_Properties_Rights_STATUS
Used by: NamespacesEventhubsAuthorizationRule_STATUS.
| Value | Description |
|---|---|
| “Listen” | |
| “Manage” | |
| “Send” |
NamespacesAuthorizationRuleOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: NamespacesAuthorizationRule_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
| secrets | configures where to place Azure generated secrets. | NamespacesAuthorizationRuleOperatorSecrets Optional |
NamespacesEventhubOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: NamespacesEventhub_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
NamespacesEventhubsAuthorizationRuleOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: NamespacesEventhubsAuthorizationRule_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
| secrets | configures where to place Azure generated secrets. | NamespacesEventhubsAuthorizationRuleOperatorSecrets Optional |
NamespacesEventhubsConsumerGroupOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: NamespacesEventhubsConsumerGroup_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
PrivateEndpointConnection_STATUS
Properties of the PrivateEndpointConnection.
Used by: Namespace_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
RetentionDescription
Properties to configure retention settings for the eventhub
Used by: NamespacesEventhub_Spec.
| Property | Description | Type |
|---|---|---|
| cleanupPolicy | Enumerates the possible values for cleanup policy | RetentionDescription_CleanupPolicy Optional |
| retentionTimeInHours | Number of hours to retain the events for this Event Hub. This value is only used when cleanupPolicy is Delete. If cleanupPolicy is Compact the returned value of this property is Long.MaxValue | int Optional |
| tombstoneRetentionTimeInHours | Number of hours to retain the tombstone markers of a compacted Event Hub. This value is only used when cleanupPolicy is Compact. 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 | int Optional |
RetentionDescription_STATUS
Properties to configure retention settings for the eventhub
Used by: NamespacesEventhub_STATUS.
| Property | Description | Type |
|---|---|---|
| cleanupPolicy | Enumerates the possible values for cleanup policy | RetentionDescription_CleanupPolicy_STATUS Optional |
| retentionTimeInHours | Number of hours to retain the events for this Event Hub. This value is only used when cleanupPolicy is Delete. If cleanupPolicy is Compact the returned value of this property is Long.MaxValue | int Optional |
| tombstoneRetentionTimeInHours | Number of hours to retain the tombstone markers of a compacted Event Hub. This value is only used when cleanupPolicy is Compact. 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 | int Optional |
Sku
SKU parameters supplied to the create namespace operation
Used by: Namespace_Spec.
| Property | Description | Type |
|---|---|---|
| capacity | 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. | int Optional |
| name | Name of this SKU. | Sku_Name Required |
| tier | The billing tier of this particular SKU. | Sku_Tier Optional |
Sku_STATUS
SKU parameters supplied to the create namespace operation
Used by: Namespace_STATUS.
| Property | Description | Type |
|---|---|---|
| capacity | 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. | int Optional |
| name | Name of this SKU. | Sku_Name_STATUS Optional |
| tier | The billing tier of this particular SKU. | Sku_Tier_STATUS Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: Namespace_STATUS, NamespacesAuthorizationRule_STATUS, NamespacesEventhub_STATUS, NamespacesEventhubsAuthorizationRule_STATUS, and NamespacesEventhubsConsumerGroup_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
| lastModifiedAt | The type of identity that last modified the resource. | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
CaptureDescription_Encoding
Used by: CaptureDescription.
| Value | Description |
|---|---|
| “Avro” | |
| “AvroDeflate” |
CaptureDescription_Encoding_STATUS
Used by: CaptureDescription_STATUS.
| Value | Description |
|---|---|
| “Avro” | |
| “AvroDeflate” |
Destination
Capture storage details for capture description
Used by: CaptureDescription.
| Property | Description | Type |
|---|---|---|
| archiveNameFormat | 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 | string Optional |
| blobContainer | Blob container Name | string Optional |
| dataLakeAccountName | The Azure Data Lake Store name for the captured events | string Optional |
| dataLakeFolderPath | The destination folder path for the captured events | string Optional |
| dataLakeSubscriptionId | Subscription Id of Azure Data Lake Store | string Optional |
| identity | A value that indicates whether capture description is enabled. | CaptureIdentity Optional |
| name | Name for capture destination | string Optional |
| storageAccountResourceReference | Resource id of the storage account to be used to create the blobs | genruntime.ResourceReference Optional |
Destination_STATUS
Capture storage details for capture description
Used by: CaptureDescription_STATUS.
| Property | Description | Type |
|---|---|---|
| archiveNameFormat | 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 | string Optional |
| blobContainer | Blob container Name | string Optional |
| dataLakeAccountName | The Azure Data Lake Store name for the captured events | string Optional |
| dataLakeFolderPath | The destination folder path for the captured events | string Optional |
| dataLakeSubscriptionId | Subscription Id of Azure Data Lake Store | string Optional |
| identity | A value that indicates whether capture description is enabled. | CaptureIdentity_STATUS Optional |
| name | Name for capture destination | string Optional |
| storageAccountResourceId | Resource id of the storage account to be used to create the blobs | string Optional |
Encryption_KeySource
Used by: Encryption.
| Value | Description |
|---|---|
| “Microsoft.KeyVault” |
Encryption_KeySource_STATUS
Used by: Encryption_STATUS.
| Value | Description |
|---|---|
| “Microsoft.KeyVault” |
Identity_Type
Used by: Identity.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned, UserAssigned” | |
| “UserAssigned” |
Identity_Type_STATUS
Used by: Identity_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned, UserAssigned” | |
| “UserAssigned” |
KeyVaultProperties
Properties to configure keyVault Properties
Used by: Encryption.
| Property | Description | Type |
|---|---|---|
| identity | UserAssignedIdentityProperties Optional |
|
| keyName | Name of the Key from KeyVault | string Optional |
| keyVaultUri | Uri of KeyVault | string Optional |
| keyVersion | Key Version | string Optional |
KeyVaultProperties_STATUS
Properties to configure keyVault Properties
Used by: Encryption_STATUS.
| Property | Description | Type |
|---|---|---|
| identity | UserAssignedIdentityProperties_STATUS Optional |
|
| keyName | Name of the Key from KeyVault | string Optional |
| keyVaultUri | Uri of KeyVault | string Optional |
| keyVersion | Key Version | string Optional |
NamespaceOperatorSecrets
Used by: NamespaceOperatorSpec.
| Property | Description | Type |
|---|---|---|
| primaryConnectionString | indicates where the PrimaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| primaryKey | indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryConnectionString | indicates where the SecondaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryKey | indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
NamespacesAuthorizationRuleOperatorSecrets
Used by: NamespacesAuthorizationRuleOperatorSpec.
| Property | Description | Type |
|---|---|---|
| primaryConnectionString | indicates where the PrimaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| primaryKey | indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryConnectionString | indicates where the SecondaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryKey | indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
NamespacesEventhubsAuthorizationRuleOperatorSecrets
Used by: NamespacesEventhubsAuthorizationRuleOperatorSpec.
| Property | Description | Type |
|---|---|---|
| primaryConnectionString | indicates where the PrimaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| primaryKey | indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryConnectionString | indicates where the SecondaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryKey | indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
RetentionDescription_CleanupPolicy
Used by: RetentionDescription.
| Value | Description |
|---|---|
| “Compact” | |
| “Delete” |
RetentionDescription_CleanupPolicy_STATUS
Used by: RetentionDescription_STATUS.
| Value | Description |
|---|---|
| “Compact” | |
| “Delete” |
Sku_Name
Used by: Sku.
| Value | Description |
|---|---|
| “Basic” | |
| “Premium” | |
| “Standard” |
Sku_Name_STATUS
Used by: Sku_STATUS.
| Value | Description |
|---|---|
| “Basic” | |
| “Premium” | |
| “Standard” |
Sku_Tier
Used by: Sku.
| Value | Description |
|---|---|
| “Basic” | |
| “Premium” | |
| “Standard” |
Sku_Tier_STATUS
Used by: Sku_STATUS.
| Value | Description |
|---|---|
| “Basic” | |
| “Premium” | |
| “Standard” |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
UserAssignedIdentity_STATUS
Recognized Dictionary value.
Used by: Identity_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | Client Id of user assigned identity | string Optional |
| principalId | Principal Id of user assigned identity | string Optional |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: Identity.
| Property | Description | Type |
|---|---|---|
| reference | genruntime.ResourceReference Optional |
CaptureIdentity
A value that indicates whether capture description is enabled.
Used by: Destination.
| Property | Description | Type |
|---|---|---|
| type | Type of Azure Active Directory Managed Identity. | CaptureIdentity_Type Optional |
| userAssignedIdentityReference | 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. | genruntime.ResourceReference Optional |
CaptureIdentity_STATUS
A value that indicates whether capture description is enabled.
Used by: Destination_STATUS.
| Property | Description | Type |
|---|---|---|
| type | Type of Azure Active Directory Managed Identity. | CaptureIdentity_Type_STATUS Optional |
| userAssignedIdentity | 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. | string Optional |
UserAssignedIdentityProperties
Used by: KeyVaultProperties.
| Property | Description | Type |
|---|---|---|
| userAssignedIdentityReference | ARM ID of user Identity selected for encryption | genruntime.ResourceReference Optional |
UserAssignedIdentityProperties_STATUS
Used by: KeyVaultProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| userAssignedIdentity | ARM ID of user Identity selected for encryption | string Optional |
CaptureIdentity_Type
Used by: CaptureIdentity.
| Value | Description |
|---|---|
| “SystemAssigned” | |
| “UserAssigned” |
CaptureIdentity_Type_STATUS
Used by: CaptureIdentity_STATUS.
| Value | Description |
|---|---|
| “SystemAssigned” | |
| “UserAssigned” |