eventhub.azure.com/v1beta20211101

eventhub.azure.com/v1beta20211101

Package v1beta20211101 contains API Schema definitions for the eventhub v1beta20211101 API group

Resource Types:

    APIVersion (string alias)

    Value Description

    "2021-11-01"

    AuthorizationRulePropertiesARM

    (Appears on:NamespacesAuthorizationRules_SpecARM, NamespacesEventhubsAuthorizationRules_SpecARM)

    Field Description
    rights
    []AuthorizationRulePropertiesRights

    Rights: The rights associated with the rule.

    AuthorizationRulePropertiesRights (string alias)

    (Appears on:AuthorizationRulePropertiesARM, NamespacesAuthorizationRules_Spec, NamespacesEventhubsAuthorizationRules_Spec)

    Value Description

    "Listen"

    "Manage"

    "Send"

    AuthorizationRuleStatusPropertiesRights (string alias)

    (Appears on:AuthorizationRule_Status, AuthorizationRule_Status_PropertiesARM)

    Value Description

    "Listen"

    "Manage"

    "Send"

    AuthorizationRule_Status

    (Appears on:NamespacesAuthorizationRule, NamespacesEventhubsAuthorizationRule)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    location
    string

    Location: The geo-location where the resource lives

    name
    string

    Name: The name of the resource

    rights
    []AuthorizationRuleStatusPropertiesRights

    Rights: The rights associated with the rule.

    systemData
    SystemData_Status

    SystemData: The system meta data relating to this resource.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”

    AuthorizationRule_StatusARM

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    location
    string

    Location: The geo-location where the resource lives

    name
    string

    Name: The name of the resource

    properties
    AuthorizationRule_Status_PropertiesARM

    Properties: Properties supplied to create or update AuthorizationRule

    systemData
    SystemData_StatusARM

    SystemData: The system meta data relating to this resource.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”

    AuthorizationRule_Status_PropertiesARM

    (Appears on:AuthorizationRule_StatusARM)

    Field Description
    rights
    []AuthorizationRuleStatusPropertiesRights

    Rights: The rights associated with the rule.

    CaptureDescriptionStatusEncoding (string alias)

    (Appears on:CaptureDescription_Status, CaptureDescription_StatusARM)

    Value Description

    "Avro"

    "AvroDeflate"

    CaptureDescription_Status

    (Appears on:Eventhub_Status)

    Field Description
    destination
    Destination_Status

    Destination: Properties of Destination where capture will be stored. (Storage Account, Blob Names)

    enabled
    bool

    Enabled: A value that indicates whether capture description is enabled.

    encoding
    CaptureDescriptionStatusEncoding

    Encoding: Enumerates the possible values for the encoding format of capture description. Note: ‘AvroDeflate’ will be deprecated in New API Version

    intervalInSeconds
    int

    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

    sizeLimitInBytes
    int

    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

    skipEmptyArchives
    bool

    SkipEmptyArchives: A value that indicates whether to Skip Empty Archives

    CaptureDescription_StatusARM

    (Appears on:Eventhub_Status_PropertiesARM)

    Field Description
    destination
    Destination_StatusARM

    Destination: Properties of Destination where capture will be stored. (Storage Account, Blob Names)

    enabled
    bool

    Enabled: A value that indicates whether capture description is enabled.

    encoding
    CaptureDescriptionStatusEncoding

    Encoding: Enumerates the possible values for the encoding format of capture description. Note: ‘AvroDeflate’ will be deprecated in New API Version

    intervalInSeconds
    int

    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

    sizeLimitInBytes
    int

    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

    skipEmptyArchives
    bool

    SkipEmptyArchives: A value that indicates whether to Skip Empty Archives

    ConsumerGroupPropertiesARM

    (Appears on:NamespacesEventhubsConsumergroups_SpecARM)

    Field Description
    userMetadata
    string

    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.

    ConsumerGroup_Status

    (Appears on:NamespacesEventhubsConsumerGroup)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    createdAt
    string

    CreatedAt: Exact time the message was created.

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    location
    string

    Location: The geo-location where the resource lives

    name
    string

    Name: The name of the resource

    systemData
    SystemData_Status

    SystemData: The system meta data relating to this resource.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”

    updatedAt
    string

    UpdatedAt: The exact time the message was updated.

    userMetadata
    string

    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.

    ConsumerGroup_StatusARM

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    location
    string

    Location: The geo-location where the resource lives

    name
    string

    Name: The name of the resource

    properties
    ConsumerGroup_Status_PropertiesARM

    Properties: Single item in List or Get Consumer group operation

    systemData
    SystemData_StatusARM

    SystemData: The system meta data relating to this resource.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”

    ConsumerGroup_Status_PropertiesARM

    (Appears on:ConsumerGroup_StatusARM)

    Field Description
    createdAt
    string

    CreatedAt: Exact time the message was created.

    updatedAt
    string

    UpdatedAt: The exact time the message was updated.

    userMetadata
    string

    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.

    DestinationPropertiesARM

    (Appears on:NamespacesEventhubs_Spec_Properties_CaptureDescription_DestinationARM)

    Field Description
    archiveNameFormat
    string

    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

    blobContainer
    string

    BlobContainer: Blob container Name

    dataLakeAccountName
    string

    DataLakeAccountName: The Azure Data Lake Store name for the captured events

    dataLakeFolderPath
    string

    DataLakeFolderPath: The destination folder path for the captured events

    dataLakeSubscriptionId
    string

    DataLakeSubscriptionId: Subscription Id of Azure Data Lake Store

    storageAccountResourceId
    string

    Destination_Status

    (Appears on:CaptureDescription_Status)

    Field Description
    archiveNameFormat
    string

    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

    blobContainer
    string

    BlobContainer: Blob container Name

    dataLakeAccountName
    string

    DataLakeAccountName: The Azure Data Lake Store name for the captured events

    dataLakeFolderPath
    string

    DataLakeFolderPath: The destination folder path for the captured events

    dataLakeSubscriptionId
    string

    DataLakeSubscriptionId: Subscription Id of Azure Data Lake Store

    name
    string

    Name: Name for capture destination

    storageAccountResourceId
    string

    StorageAccountResourceId: Resource id of the storage account to be used to create the blobs

    Destination_StatusARM

    (Appears on:CaptureDescription_StatusARM)

    Field Description
    name
    string

    Name: Name for capture destination

    properties
    Destination_Status_PropertiesARM

    Properties: Properties describing the storage account, blob container and archive name format for capture destination

    Destination_Status_PropertiesARM

    (Appears on:Destination_StatusARM)

    Field Description
    archiveNameFormat
    string

    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

    blobContainer
    string

    BlobContainer: Blob container Name

    dataLakeAccountName
    string

    DataLakeAccountName: The Azure Data Lake Store name for the captured events

    dataLakeFolderPath
    string

    DataLakeFolderPath: The destination folder path for the captured events

    dataLakeSubscriptionId
    string

    DataLakeSubscriptionId: Subscription Id of Azure Data Lake Store

    storageAccountResourceId
    string

    StorageAccountResourceId: Resource id of the storage account to be used to create the blobs

    EHNamespace_Status

    (Appears on:Namespace)

    Field Description
    alternateName
    string

    AlternateName: Alternate name specified when alias and namespace names are same.

    clusterArmId
    string

    ClusterArmId: Cluster ARM ID of the Namespace.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    createdAt
    string

    CreatedAt: The time the Namespace was created.

    disableLocalAuth
    bool

    DisableLocalAuth: This property disables SAS authentication for the Event Hubs namespace.

    encryption
    Encryption_Status

    Encryption: Properties of BYOK Encryption description

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    identity
    Identity_Status

    Identity: Properties of BYOK Identity description

    isAutoInflateEnabled
    bool

    IsAutoInflateEnabled: Value that indicates whether AutoInflate is enabled for eventhub namespace.

    kafkaEnabled
    bool

    KafkaEnabled: Value that indicates whether Kafka is enabled for eventhub namespace.

    location
    string

    Location: Resource location.

    maximumThroughputUnits
    int

    MaximumThroughputUnits: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( ‘0’ if AutoInflateEnabled = true)

    metricId
    string

    MetricId: Identifier for Azure Insights metrics.

    name
    string

    Name: The name of the resource

    privateEndpointConnections
    []PrivateEndpointConnection_Status_SubResourceEmbedded

    PrivateEndpointConnections: List of private endpoint connections.

    provisioningState
    string

    ProvisioningState: Provisioning state of the Namespace.

    serviceBusEndpoint
    string

    ServiceBusEndpoint: Endpoint you can use to perform Service Bus operations.

    sku
    Sku_Status

    Sku: Properties of sku resource

    status
    string

    Status: Status of the Namespace.

    systemData
    SystemData_Status

    SystemData: The system meta data relating to this resource.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    updatedAt
    string

    UpdatedAt: The time the Namespace was updated.

    zoneRedundant
    bool

    ZoneRedundant: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones.

    EHNamespace_StatusARM

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    identity
    Identity_StatusARM

    Identity: Properties of BYOK Identity description

    location
    string

    Location: Resource location.

    name
    string

    Name: The name of the resource

    properties
    EHNamespace_Status_PropertiesARM

    Properties: Namespace properties supplied for create namespace operation.

    sku
    Sku_StatusARM

    Sku: Properties of sku resource

    systemData
    SystemData_StatusARM

    SystemData: The system meta data relating to this resource.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    EHNamespace_Status_PropertiesARM

    (Appears on:EHNamespace_StatusARM)

    Field Description
    alternateName
    string

    AlternateName: Alternate name specified when alias and namespace names are same.

    clusterArmId
    string

    ClusterArmId: Cluster ARM ID of the Namespace.

    createdAt
    string

    CreatedAt: The time the Namespace was created.

    disableLocalAuth
    bool

    DisableLocalAuth: This property disables SAS authentication for the Event Hubs namespace.

    encryption
    Encryption_StatusARM

    Encryption: Properties of BYOK Encryption description

    isAutoInflateEnabled
    bool

    IsAutoInflateEnabled: Value that indicates whether AutoInflate is enabled for eventhub namespace.

    kafkaEnabled
    bool

    KafkaEnabled: Value that indicates whether Kafka is enabled for eventhub namespace.

    maximumThroughputUnits
    int

    MaximumThroughputUnits: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( ‘0’ if AutoInflateEnabled = true)

    metricId
    string

    MetricId: Identifier for Azure Insights metrics.

    privateEndpointConnections
    []PrivateEndpointConnection_Status_SubResourceEmbeddedARM

    PrivateEndpointConnections: List of private endpoint connections.

    provisioningState
    string

    ProvisioningState: Provisioning state of the Namespace.

    serviceBusEndpoint
    string

    ServiceBusEndpoint: Endpoint you can use to perform Service Bus operations.

    status
    string

    Status: Status of the Namespace.

    updatedAt
    string

    UpdatedAt: The time the Namespace was updated.

    zoneRedundant
    bool

    ZoneRedundant: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones.

    Encryption

    (Appears on:Namespaces_Spec)

    Field Description
    keySource
    EncryptionKeySource

    KeySource: Enumerates the possible value of keySource for Encryption.

    keyVaultProperties
    []KeyVaultProperties

    KeyVaultProperties: Properties of KeyVault

    requireInfrastructureEncryption
    bool

    RequireInfrastructureEncryption: Enable Infrastructure Encryption (Double Encryption)

    EncryptionARM

    (Appears on:Namespaces_Spec_PropertiesARM)

    Field Description
    keySource
    EncryptionKeySource

    KeySource: Enumerates the possible value of keySource for Encryption.

    keyVaultProperties
    []KeyVaultPropertiesARM

    KeyVaultProperties: Properties of KeyVault

    requireInfrastructureEncryption
    bool

    RequireInfrastructureEncryption: Enable Infrastructure Encryption (Double Encryption)

    EncryptionKeySource (string alias)

    (Appears on:Encryption, EncryptionARM)

    Value Description

    "Microsoft.KeyVault"

    EncryptionStatusKeySource (string alias)

    (Appears on:Encryption_Status, Encryption_StatusARM)

    Value Description

    "Microsoft.KeyVault"

    Encryption_Status

    (Appears on:EHNamespace_Status)

    Field Description
    keySource
    EncryptionStatusKeySource

    KeySource: Enumerates the possible value of keySource for Encryption

    keyVaultProperties
    []KeyVaultProperties_Status

    KeyVaultProperties: Properties of KeyVault

    requireInfrastructureEncryption
    bool

    RequireInfrastructureEncryption: Enable Infrastructure Encryption (Double Encryption)

    Encryption_StatusARM

    (Appears on:EHNamespace_Status_PropertiesARM)

    Field Description
    keySource
    EncryptionStatusKeySource

    KeySource: Enumerates the possible value of keySource for Encryption

    keyVaultProperties
    []KeyVaultProperties_StatusARM

    KeyVaultProperties: Properties of KeyVault

    requireInfrastructureEncryption
    bool

    RequireInfrastructureEncryption: Enable Infrastructure Encryption (Double Encryption)

    EventhubStatusPropertiesStatus (string alias)

    (Appears on:Eventhub_Status, Eventhub_Status_PropertiesARM)

    Value Description

    "Active"

    "Creating"

    "Deleting"

    "Disabled"

    "ReceiveDisabled"

    "Renaming"

    "Restoring"

    "SendDisabled"

    "Unknown"

    Eventhub_Status

    (Appears on:NamespacesEventhub)

    Field Description
    captureDescription
    CaptureDescription_Status

    CaptureDescription: Properties of capture description

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    createdAt
    string

    CreatedAt: Exact time the Event Hub was created.

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    location
    string

    Location: The geo-location where the resource lives

    messageRetentionInDays
    int

    MessageRetentionInDays: Number of days to retain the events for this Event Hub, value should be 1 to 7 days

    name
    string

    Name: The name of the resource

    partitionCount
    int

    PartitionCount: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.

    partitionIds
    []string

    PartitionIds: Current number of shards on the Event Hub.

    status
    EventhubStatusPropertiesStatus

    Status: Enumerates the possible values for the status of the Event Hub.

    systemData
    SystemData_Status

    SystemData: The system meta data relating to this resource.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”

    updatedAt
    string

    UpdatedAt: The exact time the message was updated.

    Eventhub_StatusARM

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    location
    string

    Location: The geo-location where the resource lives

    name
    string

    Name: The name of the resource

    properties
    Eventhub_Status_PropertiesARM

    Properties: Properties supplied to the Create Or Update Event Hub operation.

    systemData
    SystemData_StatusARM

    SystemData: The system meta data relating to this resource.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs”

    Eventhub_Status_PropertiesARM

    (Appears on:Eventhub_StatusARM)

    Field Description
    captureDescription
    CaptureDescription_StatusARM

    CaptureDescription: Properties of capture description

    createdAt
    string

    CreatedAt: Exact time the Event Hub was created.

    messageRetentionInDays
    int

    MessageRetentionInDays: Number of days to retain the events for this Event Hub, value should be 1 to 7 days

    partitionCount
    int

    PartitionCount: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.

    partitionIds
    []string

    PartitionIds: Current number of shards on the Event Hub.

    status
    EventhubStatusPropertiesStatus

    Status: Enumerates the possible values for the status of the Event Hub.

    updatedAt
    string

    UpdatedAt: The exact time the message was updated.

    Identity

    (Appears on:Namespaces_Spec)

    Field Description
    type
    IdentityType

    Type: Type of managed service identity.

    IdentityARM

    (Appears on:Namespaces_SpecARM)

    Field Description
    type
    IdentityType

    Type: Type of managed service identity.

    IdentityStatusType (string alias)

    (Appears on:Identity_Status, Identity_StatusARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned, UserAssigned"

    "UserAssigned"

    IdentityType (string alias)

    (Appears on:Identity, IdentityARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned, UserAssigned"

    "UserAssigned"

    Identity_Status

    (Appears on:EHNamespace_Status)

    Field Description
    principalId
    string

    PrincipalId: ObjectId from the KeyVault

    tenantId
    string

    TenantId: TenantId from the KeyVault

    type
    IdentityStatusType

    Type: Type of managed service identity.

    userAssignedIdentities
    map[string]./api/eventhub/v1beta20211101.UserAssignedIdentity_Status

    UserAssignedIdentities: Properties for User Assigned Identities

    Identity_StatusARM

    (Appears on:EHNamespace_StatusARM)

    Field Description
    principalId
    string

    PrincipalId: ObjectId from the KeyVault

    tenantId
    string

    TenantId: TenantId from the KeyVault

    type
    IdentityStatusType

    Type: Type of managed service identity.

    userAssignedIdentities
    map[string]./api/eventhub/v1beta20211101.UserAssignedIdentity_StatusARM

    UserAssignedIdentities: Properties for User Assigned Identities

    KeyVaultProperties

    (Appears on:Encryption)

    Field Description
    identity
    UserAssignedIdentityProperties
    keyName
    string

    KeyName: Name of the Key from KeyVault

    keyVaultUri
    string

    KeyVaultUri: Uri of KeyVault

    keyVersion
    string

    KeyVersion: Key Version

    KeyVaultPropertiesARM

    (Appears on:EncryptionARM)

    Field Description
    identity
    UserAssignedIdentityPropertiesARM
    keyName
    string

    KeyName: Name of the Key from KeyVault

    keyVaultUri
    string

    KeyVaultUri: Uri of KeyVault

    keyVersion
    string

    KeyVersion: Key Version

    KeyVaultProperties_Status

    (Appears on:Encryption_Status)

    Field Description
    identity
    UserAssignedIdentityProperties_Status
    keyName
    string

    KeyName: Name of the Key from KeyVault

    keyVaultUri
    string

    KeyVaultUri: Uri of KeyVault

    keyVersion
    string

    KeyVersion: Key Version

    KeyVaultProperties_StatusARM

    (Appears on:Encryption_StatusARM)

    Field Description
    identity
    UserAssignedIdentityProperties_StatusARM
    keyName
    string

    KeyName: Name of the Key from KeyVault

    keyVaultUri
    string

    KeyVaultUri: Uri of KeyVault

    keyVersion
    string

    KeyVersion: Key Version

    Namespace

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Namespaces_Spec


    alternateName
    string

    AlternateName: Alternate name specified when alias and namespace names are same.

    azureName
    string

    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.

    clusterArmReference
    genruntime.ResourceReference

    ClusterArmReference: Cluster ARM ID of the Namespace.

    disableLocalAuth
    bool

    DisableLocalAuth: This property disables SAS authentication for the Event Hubs namespace.

    encryption
    Encryption

    Encryption: Properties to configure Encryption

    identity
    Identity

    Identity: Properties to configure Identity for Bring your Own Keys

    isAutoInflateEnabled
    bool

    IsAutoInflateEnabled: Value that indicates whether AutoInflate is enabled for eventhub namespace.

    kafkaEnabled
    bool

    KafkaEnabled: Value that indicates whether Kafka is enabled for eventhub namespace.

    location
    string

    Location: Location to deploy resource to

    maximumThroughputUnits
    int

    MaximumThroughputUnits: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( ‘0’ if AutoInflateEnabled = true)

    owner
    genruntime.KnownResourceReference

    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

    privateEndpointConnections
    []Namespaces_Spec_Properties_PrivateEndpointConnections

    PrivateEndpointConnections: List of private endpoint connections.

    sku
    Sku

    Sku: SKU parameters supplied to the create namespace operation

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    zoneRedundant
    bool

    ZoneRedundant: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones.

    status
    EHNamespace_Status

    NamespacesAuthorizationRule

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    NamespacesAuthorizationRules_Spec


    azureName
    string

    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.

    location
    string

    Location: Location to deploy resource to

    owner
    genruntime.KnownResourceReference

    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

    rights
    []AuthorizationRulePropertiesRights

    Rights: The rights associated with the rule.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    status
    AuthorizationRule_Status

    NamespacesAuthorizationRules_Spec

    (Appears on:NamespacesAuthorizationRule)

    Field Description
    azureName
    string

    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.

    location
    string

    Location: Location to deploy resource to

    owner
    genruntime.KnownResourceReference

    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

    rights
    []AuthorizationRulePropertiesRights

    Rights: The rights associated with the rule.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    NamespacesAuthorizationRules_SpecARM

    Field Description
    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: The authorization rule name.

    properties
    AuthorizationRulePropertiesARM

    Properties: Properties supplied to create or update AuthorizationRule

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    NamespacesEventhub

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    NamespacesEventhubs_Spec


    azureName
    string

    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.

    captureDescription
    NamespacesEventhubs_Spec_Properties_CaptureDescription

    CaptureDescription: Properties to configure capture description for eventhub

    location
    string

    Location: Location to deploy resource to

    messageRetentionInDays
    int

    MessageRetentionInDays: Number of days to retain the events for this Event Hub, value should be 1 to 7 days

    owner
    genruntime.KnownResourceReference

    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

    partitionCount
    int

    PartitionCount: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    status
    Eventhub_Status

    NamespacesEventhubsAuthorizationRule

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    NamespacesEventhubsAuthorizationRules_Spec


    azureName
    string

    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.

    location
    string

    Location: Location to deploy resource to

    owner
    genruntime.KnownResourceReference

    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

    rights
    []AuthorizationRulePropertiesRights

    Rights: The rights associated with the rule.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    status
    AuthorizationRule_Status

    NamespacesEventhubsAuthorizationRules_Spec

    (Appears on:NamespacesEventhubsAuthorizationRule)

    Field Description
    azureName
    string

    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.

    location
    string

    Location: Location to deploy resource to

    owner
    genruntime.KnownResourceReference

    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

    rights
    []AuthorizationRulePropertiesRights

    Rights: The rights associated with the rule.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    NamespacesEventhubsAuthorizationRules_SpecARM

    Field Description
    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: The authorization rule name.

    properties
    AuthorizationRulePropertiesARM

    Properties: Properties supplied to create or update AuthorizationRule

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    NamespacesEventhubsConsumerGroup

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    NamespacesEventhubsConsumergroups_Spec


    azureName
    string

    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.

    location
    string

    Location: Location to deploy resource to

    owner
    genruntime.KnownResourceReference

    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

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    userMetadata
    string

    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.

    status
    ConsumerGroup_Status

    NamespacesEventhubsConsumergroups_Spec

    (Appears on:NamespacesEventhubsConsumerGroup)

    Field Description
    azureName
    string

    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.

    location
    string

    Location: Location to deploy resource to

    owner
    genruntime.KnownResourceReference

    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

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    userMetadata
    string

    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.

    NamespacesEventhubsConsumergroups_SpecARM

    Field Description
    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: The consumer group name

    properties
    ConsumerGroupPropertiesARM

    Properties: Single item in List or Get Consumer group operation

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    NamespacesEventhubsSpecPropertiesCaptureDescriptionEncoding (string alias)

    (Appears on:NamespacesEventhubs_Spec_Properties_CaptureDescription, NamespacesEventhubs_Spec_Properties_CaptureDescriptionARM)

    Value Description

    "Avro"

    "AvroDeflate"

    NamespacesEventhubs_Spec

    (Appears on:NamespacesEventhub)

    Field Description
    azureName
    string

    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.

    captureDescription
    NamespacesEventhubs_Spec_Properties_CaptureDescription

    CaptureDescription: Properties to configure capture description for eventhub

    location
    string

    Location: Location to deploy resource to

    messageRetentionInDays
    int

    MessageRetentionInDays: Number of days to retain the events for this Event Hub, value should be 1 to 7 days

    owner
    genruntime.KnownResourceReference

    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

    partitionCount
    int

    PartitionCount: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    NamespacesEventhubs_SpecARM

    Field Description
    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: Name of the resource

    properties
    NamespacesEventhubs_Spec_PropertiesARM

    Properties: Properties supplied to the Create Or Update Event Hub operation.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    NamespacesEventhubs_Spec_PropertiesARM

    (Appears on:NamespacesEventhubs_SpecARM)

    Field Description
    captureDescription
    NamespacesEventhubs_Spec_Properties_CaptureDescriptionARM

    CaptureDescription: Properties to configure capture description for eventhub

    messageRetentionInDays
    int

    MessageRetentionInDays: Number of days to retain the events for this Event Hub, value should be 1 to 7 days

    partitionCount
    int

    PartitionCount: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.

    NamespacesEventhubs_Spec_Properties_CaptureDescription

    (Appears on:NamespacesEventhubs_Spec)

    Field Description
    destination
    NamespacesEventhubs_Spec_Properties_CaptureDescription_Destination

    Destination: Capture storage details for capture description

    enabled
    bool

    Enabled: A value that indicates whether capture description is enabled.

    encoding
    NamespacesEventhubsSpecPropertiesCaptureDescriptionEncoding

    Encoding: Enumerates the possible values for the encoding format of capture description. Note: ‘AvroDeflate’ will be deprecated in New API Version.

    intervalInSeconds
    int

    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

    sizeLimitInBytes
    int

    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

    skipEmptyArchives
    bool

    SkipEmptyArchives: A value that indicates whether to Skip Empty Archives

    NamespacesEventhubs_Spec_Properties_CaptureDescriptionARM

    (Appears on:NamespacesEventhubs_Spec_PropertiesARM)

    Field Description
    destination
    NamespacesEventhubs_Spec_Properties_CaptureDescription_DestinationARM

    Destination: Capture storage details for capture description

    enabled
    bool

    Enabled: A value that indicates whether capture description is enabled.

    encoding
    NamespacesEventhubsSpecPropertiesCaptureDescriptionEncoding

    Encoding: Enumerates the possible values for the encoding format of capture description. Note: ‘AvroDeflate’ will be deprecated in New API Version.

    intervalInSeconds
    int

    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

    sizeLimitInBytes
    int

    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

    skipEmptyArchives
    bool

    SkipEmptyArchives: A value that indicates whether to Skip Empty Archives

    NamespacesEventhubs_Spec_Properties_CaptureDescription_Destination

    (Appears on:NamespacesEventhubs_Spec_Properties_CaptureDescription)

    Field Description
    archiveNameFormat
    string

    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

    blobContainer
    string

    BlobContainer: Blob container Name

    dataLakeAccountName
    string

    DataLakeAccountName: The Azure Data Lake Store name for the captured events

    dataLakeFolderPath
    string

    DataLakeFolderPath: The destination folder path for the captured events

    dataLakeSubscriptionId
    string

    DataLakeSubscriptionId: Subscription Id of Azure Data Lake Store

    name
    string

    Name: Name for capture destination

    storageAccountResourceReference
    genruntime.ResourceReference

    StorageAccountResourceReference: Resource id of the storage account to be used to create the blobs

    NamespacesEventhubs_Spec_Properties_CaptureDescription_DestinationARM

    (Appears on:NamespacesEventhubs_Spec_Properties_CaptureDescriptionARM)

    Field Description
    name
    string

    Name: Name for capture destination

    properties
    DestinationPropertiesARM

    Properties: Properties describing the storage account, blob container and archive name format for capture destination

    Namespaces_Spec

    (Appears on:Namespace)

    Field Description
    alternateName
    string

    AlternateName: Alternate name specified when alias and namespace names are same.

    azureName
    string

    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.

    clusterArmReference
    genruntime.ResourceReference

    ClusterArmReference: Cluster ARM ID of the Namespace.

    disableLocalAuth
    bool

    DisableLocalAuth: This property disables SAS authentication for the Event Hubs namespace.

    encryption
    Encryption

    Encryption: Properties to configure Encryption

    identity
    Identity

    Identity: Properties to configure Identity for Bring your Own Keys

    isAutoInflateEnabled
    bool

    IsAutoInflateEnabled: Value that indicates whether AutoInflate is enabled for eventhub namespace.

    kafkaEnabled
    bool

    KafkaEnabled: Value that indicates whether Kafka is enabled for eventhub namespace.

    location
    string

    Location: Location to deploy resource to

    maximumThroughputUnits
    int

    MaximumThroughputUnits: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( ‘0’ if AutoInflateEnabled = true)

    owner
    genruntime.KnownResourceReference

    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

    privateEndpointConnections
    []Namespaces_Spec_Properties_PrivateEndpointConnections

    PrivateEndpointConnections: List of private endpoint connections.

    sku
    Sku

    Sku: SKU parameters supplied to the create namespace operation

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    zoneRedundant
    bool

    ZoneRedundant: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones.

    Namespaces_SpecARM

    Field Description
    identity
    IdentityARM

    Identity: Properties to configure Identity for Bring your Own Keys

    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: Name of the resource

    properties
    Namespaces_Spec_PropertiesARM

    Properties: Namespace properties supplied for create namespace operation.

    sku
    SkuARM

    Sku: SKU parameters supplied to the create namespace operation

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    Namespaces_Spec_PropertiesARM

    (Appears on:Namespaces_SpecARM)

    Field Description
    alternateName
    string

    AlternateName: Alternate name specified when alias and namespace names are same.

    clusterArmId
    string
    disableLocalAuth
    bool

    DisableLocalAuth: This property disables SAS authentication for the Event Hubs namespace.

    encryption
    EncryptionARM

    Encryption: Properties to configure Encryption

    isAutoInflateEnabled
    bool

    IsAutoInflateEnabled: Value that indicates whether AutoInflate is enabled for eventhub namespace.

    kafkaEnabled
    bool

    KafkaEnabled: Value that indicates whether Kafka is enabled for eventhub namespace.

    maximumThroughputUnits
    int

    MaximumThroughputUnits: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( ‘0’ if AutoInflateEnabled = true)

    privateEndpointConnections
    []Namespaces_Spec_Properties_PrivateEndpointConnectionsARM

    PrivateEndpointConnections: List of private endpoint connections.

    zoneRedundant
    bool

    ZoneRedundant: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones.

    Namespaces_Spec_Properties_PrivateEndpointConnections

    (Appears on:Namespaces_Spec)

    Field Description
    privateEndpoint
    PrivateEndpoint

    PrivateEndpoint: PrivateEndpoint information.

    Namespaces_Spec_Properties_PrivateEndpointConnectionsARM

    (Appears on:Namespaces_Spec_PropertiesARM)

    Field Description
    properties
    PrivateEndpointConnectionPropertiesARM

    Properties: Properties of the private endpoint connection resource.

    PrivateEndpoint

    (Appears on:Namespaces_Spec_Properties_PrivateEndpointConnections)

    Field Description
    reference
    genruntime.ResourceReference

    Reference: The ARM identifier for Private Endpoint.

    PrivateEndpointARM

    (Appears on:PrivateEndpointConnectionPropertiesARM)

    Field Description
    id
    string

    PrivateEndpointConnectionPropertiesARM

    (Appears on:Namespaces_Spec_Properties_PrivateEndpointConnectionsARM)

    Field Description
    privateEndpoint
    PrivateEndpointARM

    PrivateEndpoint: PrivateEndpoint information.

    PrivateEndpointConnection_Status_SubResourceEmbedded

    (Appears on:EHNamespace_Status)

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    systemData
    SystemData_Status

    SystemData: The system meta data relating to this resource.

    PrivateEndpointConnection_Status_SubResourceEmbeddedARM

    (Appears on:EHNamespace_Status_PropertiesARM)

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    systemData
    SystemData_StatusARM

    SystemData: The system meta data relating to this resource.

    Sku

    (Appears on:Namespaces_Spec)

    Field Description
    capacity
    int

    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.

    name
    SkuName

    Name: Name of this SKU.

    tier
    SkuTier

    Tier: The billing tier of this particular SKU.

    SkuARM

    (Appears on:Namespaces_SpecARM)

    Field Description
    capacity
    int

    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.

    name
    SkuName

    Name: Name of this SKU.

    tier
    SkuTier

    Tier: The billing tier of this particular SKU.

    SkuName (string alias)

    (Appears on:Sku, SkuARM)

    Value Description

    "Basic"

    "Premium"

    "Standard"

    SkuStatusName (string alias)

    (Appears on:Sku_Status, Sku_StatusARM)

    Value Description

    "Basic"

    "Premium"

    "Standard"

    SkuStatusTier (string alias)

    (Appears on:Sku_Status, Sku_StatusARM)

    Value Description

    "Basic"

    "Premium"

    "Standard"

    SkuTier (string alias)

    (Appears on:Sku, SkuARM)

    Value Description

    "Basic"

    "Premium"

    "Standard"

    Sku_Status

    (Appears on:EHNamespace_Status)

    Field Description
    capacity
    int

    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.

    name
    SkuStatusName

    Name: Name of this SKU.

    tier
    SkuStatusTier

    Tier: The billing tier of this particular SKU.

    Sku_StatusARM

    (Appears on:EHNamespace_StatusARM)

    Field Description
    capacity
    int

    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.

    name
    SkuStatusName

    Name: Name of this SKU.

    tier
    SkuStatusTier

    Tier: The billing tier of this particular SKU.

    SystemDataStatusCreatedByType (string alias)

    (Appears on:SystemData_Status, SystemData_StatusARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemDataStatusLastModifiedByType (string alias)

    (Appears on:SystemData_Status, SystemData_StatusARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_Status

    (Appears on:AuthorizationRule_Status, ConsumerGroup_Status, EHNamespace_Status, Eventhub_Status, PrivateEndpointConnection_Status_SubResourceEmbedded)

    Field Description
    createdAt
    string

    CreatedAt: The timestamp of resource creation (UTC).

    createdBy
    string

    CreatedBy: The identity that created the resource.

    createdByType
    SystemDataStatusCreatedByType

    CreatedByType: The type of identity that created the resource.

    lastModifiedAt
    string

    LastModifiedAt: The type of identity that last modified the resource.

    lastModifiedBy
    string

    LastModifiedBy: The identity that last modified the resource.

    lastModifiedByType
    SystemDataStatusLastModifiedByType

    LastModifiedByType: The type of identity that last modified the resource.

    SystemData_StatusARM

    (Appears on:AuthorizationRule_StatusARM, ConsumerGroup_StatusARM, EHNamespace_StatusARM, Eventhub_StatusARM, PrivateEndpointConnection_Status_SubResourceEmbeddedARM)

    Field Description
    createdAt
    string

    CreatedAt: The timestamp of resource creation (UTC).

    createdBy
    string

    CreatedBy: The identity that created the resource.

    createdByType
    SystemDataStatusCreatedByType

    CreatedByType: The type of identity that created the resource.

    lastModifiedAt
    string

    LastModifiedAt: The type of identity that last modified the resource.

    lastModifiedBy
    string

    LastModifiedBy: The identity that last modified the resource.

    lastModifiedByType
    SystemDataStatusLastModifiedByType

    LastModifiedByType: The type of identity that last modified the resource.

    UserAssignedIdentityProperties

    (Appears on:KeyVaultProperties)

    Field Description
    userAssignedIdentityReference
    genruntime.ResourceReference

    UserAssignedIdentityReference: ARM ID of user Identity selected for encryption

    UserAssignedIdentityPropertiesARM

    (Appears on:KeyVaultPropertiesARM)

    Field Description
    userAssignedIdentity
    string

    UserAssignedIdentityProperties_Status

    (Appears on:KeyVaultProperties_Status)

    Field Description
    userAssignedIdentity
    string

    UserAssignedIdentity: ARM ID of user Identity selected for encryption

    UserAssignedIdentityProperties_StatusARM

    (Appears on:KeyVaultProperties_StatusARM)

    Field Description
    userAssignedIdentity
    string

    UserAssignedIdentity: ARM ID of user Identity selected for encryption

    UserAssignedIdentity_Status

    (Appears on:Identity_Status)

    Field Description
    clientId
    string

    ClientId: Client Id of user assigned identity

    principalId
    string

    PrincipalId: Principal Id of user assigned identity

    UserAssignedIdentity_StatusARM

    (Appears on:Identity_StatusARM)

    Field Description
    clientId
    string

    ClientId: Client Id of user assigned identity

    principalId
    string

    PrincipalId: Principal Id of user assigned identity