notificationhubs.azure.com/v1api20230901

notificationhubs.azure.com/v1api20230901

Package v1api20230901 contains API Schema definitions for the notificationhubs v1api20230901 API group

Resource Types:

    APIVersion (string alias)

    Value Description

    "2023-09-01"

    AccessRights (string alias)

    (Appears on:IpRule, PublicInternetAuthorizationRule, SharedAccessAuthorizationRuleProperties)

    Defines values for AccessRights.

    Value Description

    "Listen"

    "Manage"

    "Send"

    AccessRights_STATUS (string alias)

    (Appears on:IpRule_STATUS, PublicInternetAuthorizationRule_STATUS, SharedAccessAuthorizationRuleProperties_STATUS)

    Defines values for AccessRights.

    Value Description

    "Listen"

    "Manage"

    "Send"

    AdmCredential

    (Appears on:NotificationHubProperties, PnsCredentials)

    Description of a NotificationHub AdmCredential.

    Field Description
    properties
    AdmCredentialProperties

    Properties: Description of a NotificationHub AdmCredential.

    AdmCredentialProperties

    (Appears on:AdmCredential)

    Description of a NotificationHub AdmCredential.

    Field Description
    authTokenUrl
    genruntime.SecretReference

    AuthTokenUrl: Gets or sets the URL of the authorization token.
    clientId
    genruntime.SecretReference

    ClientId: Gets or sets the client identifier.
    clientSecret
    genruntime.SecretReference

    ClientSecret: Gets or sets the credential secret access key.

    AdmCredentialProperties_STATUS

    (Appears on:AdmCredential_STATUS)

    Description of a NotificationHub AdmCredential.

    AdmCredential_STATUS

    (Appears on:NotificationHubProperties_STATUS, PnsCredentials_STATUS)

    Description of a NotificationHub AdmCredential.

    Field Description
    properties
    AdmCredentialProperties_STATUS

    Properties: Description of a NotificationHub AdmCredential.

    ApnsCredential

    (Appears on:NotificationHubProperties, PnsCredentials)

    Description of a NotificationHub ApnsCredential.

    Field Description
    properties
    ApnsCredentialProperties

    Properties: Description of a NotificationHub ApnsCredential.

    ApnsCredentialProperties

    (Appears on:ApnsCredential)

    Description of a NotificationHub ApnsCredential.

    Field Description
    apnsCertificate
    genruntime.SecretReference

    ApnsCertificate: Gets or sets the APNS certificate.
    appId
    genruntime.SecretReference

    AppId: Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account
    appName
    genruntime.SecretReference

    AppName: Gets or sets the name of the application
    certificateKey
    genruntime.SecretReference

    CertificateKey: Gets or sets the certificate key.
    endpoint
    genruntime.SecretReference

    Endpoint: Gets or sets the endpoint of this credential.
    keyId
    genruntime.SecretReference

    KeyId: Gets or sets a 10-character key identifier (kid) key, obtained from your developer account
    thumbprint
    genruntime.SecretReference

    Thumbprint: Gets or sets the APNS certificate Thumbprint
    token
    genruntime.SecretReference

    Token: Gets or sets provider Authentication Token, obtained through your developer account

    ApnsCredentialProperties_STATUS

    (Appears on:ApnsCredential_STATUS)

    Description of a NotificationHub ApnsCredential.

    ApnsCredential_STATUS

    (Appears on:NotificationHubProperties_STATUS, PnsCredentials_STATUS)

    Description of a NotificationHub ApnsCredential.

    Field Description
    properties
    ApnsCredentialProperties_STATUS

    Properties: Description of a NotificationHub ApnsCredential.

    BaiduCredential

    (Appears on:NotificationHubProperties, PnsCredentials)

    Description of a NotificationHub BaiduCredential.

    Field Description
    properties
    BaiduCredentialProperties

    Properties: Description of a NotificationHub BaiduCredential.

    BaiduCredentialProperties

    (Appears on:BaiduCredential)

    Description of a NotificationHub BaiduCredential.

    Field Description
    baiduApiKey
    genruntime.SecretReference

    BaiduApiKey: Gets or sets baidu Api Key.
    baiduEndPoint
    genruntime.SecretReference

    BaiduEndPoint: Gets or sets baidu Endpoint.
    baiduSecretKey
    genruntime.SecretReference

    BaiduSecretKey: Gets or sets baidu Secret Key

    BaiduCredentialProperties_STATUS

    (Appears on:BaiduCredential_STATUS)

    Description of a NotificationHub BaiduCredential.

    BaiduCredential_STATUS

    (Appears on:NotificationHubProperties_STATUS, PnsCredentials_STATUS)

    Description of a NotificationHub BaiduCredential.

    Field Description
    properties
    BaiduCredentialProperties_STATUS

    Properties: Description of a NotificationHub BaiduCredential.

    BrowserCredential

    (Appears on:NotificationHubProperties, PnsCredentials)

    Description of a NotificationHub BrowserCredential.

    Field Description
    properties
    BrowserCredentialProperties

    Properties: Description of a NotificationHub BrowserCredential.

    BrowserCredentialProperties

    (Appears on:BrowserCredential)

    Description of a NotificationHub BrowserCredential.

    Field Description
    subject
    genruntime.SecretReference

    Subject: Gets or sets web push subject.
    vapidPrivateKey
    genruntime.SecretReference

    VapidPrivateKey: Gets or sets VAPID private key.
    vapidPublicKey
    genruntime.SecretReference

    VapidPublicKey: Gets or sets VAPID public key.

    BrowserCredentialProperties_STATUS

    (Appears on:BrowserCredential_STATUS)

    Description of a NotificationHub BrowserCredential.

    BrowserCredential_STATUS

    (Appears on:NotificationHubProperties_STATUS, PnsCredentials_STATUS)

    Description of a NotificationHub BrowserCredential.

    Field Description
    properties
    BrowserCredentialProperties_STATUS

    Properties: Description of a NotificationHub BrowserCredential.

    GcmCredential

    (Appears on:NotificationHubProperties, PnsCredentials)

    Description of a NotificationHub GcmCredential.

    Field Description
    properties
    GcmCredentialProperties

    Properties: Description of a NotificationHub GcmCredential.

    GcmCredentialProperties

    (Appears on:GcmCredential)

    Description of a NotificationHub GcmCredential.

    Field Description
    gcmEndpoint
    genruntime.SecretReference

    GcmEndpoint: Gets or sets the GCM endpoint.
    googleApiKey
    genruntime.SecretReference

    GoogleApiKey: Gets or sets the Google API key.

    GcmCredentialProperties_STATUS

    (Appears on:GcmCredential_STATUS)

    Description of a NotificationHub GcmCredential.

    GcmCredential_STATUS

    (Appears on:NotificationHubProperties_STATUS, PnsCredentials_STATUS)

    Description of a NotificationHub GcmCredential.

    Field Description
    properties
    GcmCredentialProperties_STATUS

    Properties: Description of a NotificationHub GcmCredential.

    IpRule

    (Appears on:NetworkAcls)

    A network authorization rule that filters traffic based on IP address.

    Field Description
    ipMask
    string

    IpMask: IP mask.
    rights
    []AccessRights

    Rights: List of access rights.

    IpRule_STATUS

    (Appears on:NetworkAcls_STATUS)

    A network authorization rule that filters traffic based on IP address.

    Field Description
    ipMask
    string

    IpMask: IP mask.
    rights
    []AccessRights_STATUS

    Rights: List of access rights.

    MpnsCredential

    (Appears on:NotificationHubProperties, PnsCredentials)

    Description of a NotificationHub MpnsCredential.

    Field Description
    properties
    MpnsCredentialProperties

    Properties: Description of a NotificationHub MpnsCredential.

    MpnsCredentialProperties

    (Appears on:MpnsCredential)

    Description of a NotificationHub MpnsCredential.

    Field Description
    certificateKey
    genruntime.SecretReference

    CertificateKey: Gets or sets the certificate key for this credential.
    mpnsCertificate
    genruntime.SecretReference

    MpnsCertificate: Gets or sets the MPNS certificate.
    thumbprint
    genruntime.SecretReference

    Thumbprint: Gets or sets the MPNS certificate Thumbprint

    MpnsCredentialProperties_STATUS

    (Appears on:MpnsCredential_STATUS)

    Description of a NotificationHub MpnsCredential.

    MpnsCredential_STATUS

    (Appears on:NotificationHubProperties_STATUS, PnsCredentials_STATUS)

    Description of a NotificationHub MpnsCredential.

    Field Description
    properties
    MpnsCredentialProperties_STATUS

    Properties: Description of a NotificationHub MpnsCredential.

    Namespace

    Generator information: - Generated from: /notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.NotificationHubs/​namespaces/​{namespaceName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta     		Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Namespace_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: The geo-location where the resource lives
    operatorSpec
    NamespaceOperatorSpec

    OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
    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
    properties
    NamespaceProperties

    Properties: Represents namespace properties.
    sku
    Sku

    Sku: The Sku description for a namespace
    tags
    map[string]string

    Tags: Resource tags.
    status
    Namespace_STATUS

    NamespaceOperatorConfigMaps

    (Appears on:NamespaceOperatorSpec)

    Field Description
    serviceBusEndpoint
    genruntime.ConfigMapDestination

    ServiceBusEndpoint: indicates where the ServiceBusEndpoint config map should be placed. If omitted, no config map will be created.

    NamespaceOperatorSecrets

    (Appears on:NamespaceOperatorSpec)

    Field Description
    primaryConnectionString
    genruntime.SecretDestination

    PrimaryConnectionString: indicates where the PrimaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure.
    primaryKey
    genruntime.SecretDestination

    PrimaryKey: indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure.
    secondaryConnectionString
    genruntime.SecretDestination

    SecondaryConnectionString: indicates where the SecondaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure.
    secondaryKey
    genruntime.SecretDestination

    SecondaryKey: indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure.

    NamespaceOperatorSpec

    (Appears on:Namespace_Spec)

    Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

    Field Description
    configMapExpressions
    []genruntime/core.DestinationExpression

    ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
    configMaps
    NamespaceOperatorConfigMaps

    ConfigMaps: configures where to place operator written ConfigMaps.
    secretExpressions
    []genruntime/core.DestinationExpression

    SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).
    secrets
    NamespaceOperatorSecrets

    Secrets: configures where to place Azure generated secrets.

    NamespaceProperties

    (Appears on:Namespace_Spec)

    Represents namespace properties.

    Field Description
    dataCenter
    string

    DataCenter: Deprecated.
    namespaceType
    NamespaceType

    NamespaceType: Defines values for NamespaceType.
    networkAcls
    NetworkAcls

    NetworkAcls: A collection of network authorization rules.
    pnsCredentials
    PnsCredentials

    PnsCredentials: Collection of Notification Hub or Notification Hub Namespace PNS credentials.
    publicNetworkAccess
    PublicNetworkAccess

    PublicNetworkAccess: Type of public network access.
    replicationRegion
    ReplicationRegion

    ReplicationRegion: Allowed replication region
    scaleUnit
    string

    ScaleUnit: Gets or sets scaleUnit where the namespace gets created
    zoneRedundancy
    ZoneRedundancyPreference

    ZoneRedundancy: Namespace SKU name.

    NamespaceProperties_STATUS

    (Appears on:Namespace_STATUS)

    Represents namespace properties.

    Field Description
    createdAt
    string

    CreatedAt: Time when the namespace was created.
    critical
    bool

    Critical: Gets or sets whether or not the namespace is set as Critical.
    dataCenter
    string

    DataCenter: Deprecated.
    enabled
    bool

    Enabled: Gets or sets whether or not the namespace is currently enabled.
    metricId
    string

    MetricId: Azure Insights Metrics id.
    name
    string

    Name: Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created.
    namespaceType
    NamespaceType_STATUS

    NamespaceType: Defines values for NamespaceType.
    networkAcls
    NetworkAcls_STATUS

    NetworkAcls: A collection of network authorization rules.
    pnsCredentials
    PnsCredentials_STATUS

    PnsCredentials: Collection of Notification Hub or Notification Hub Namespace PNS credentials.
    privateEndpointConnections
    []PrivateEndpointConnectionResource_STATUS

    PrivateEndpointConnections: Private Endpoint Connections for namespace
    provisioningState
    OperationProvisioningState_STATUS

    ProvisioningState: Defines values for OperationProvisioningState.
    publicNetworkAccess
    PublicNetworkAccess_STATUS

    PublicNetworkAccess: Type of public network access.
    region
    string

    Region: Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property.
    replicationRegion
    ReplicationRegion_STATUS

    ReplicationRegion: Allowed replication region
    scaleUnit
    string

    ScaleUnit: Gets or sets scaleUnit where the namespace gets created
    serviceBusEndpoint
    string

    ServiceBusEndpoint: Gets or sets endpoint you can use to perform NotificationHub operations.
    status
    NamespaceStatus_STATUS

    Status: Namespace status.
    subscriptionId
    string

    SubscriptionId: Namespace subscription id.
    updatedAt
    string

    UpdatedAt: Time when the namespace was updated.
    zoneRedundancy
    ZoneRedundancyPreference_STATUS

    ZoneRedundancy: Namespace SKU name.

    NamespaceStatus_STATUS (string alias)

    (Appears on:NamespaceProperties_STATUS)

    Namespace status.

    Value Description

    "Created"

    "Creating"

    "Deleting"

    "Suspended"

    NamespaceType (string alias)

    (Appears on:NamespaceProperties)

    Defines values for NamespaceType.

    Value Description

    "Messaging"

    "NotificationHub"

    NamespaceType_STATUS (string alias)

    (Appears on:NamespaceProperties_STATUS)

    Defines values for NamespaceType.

    Value Description

    "Messaging"

    "NotificationHub"

    Namespace_STATUS

    (Appears on:Namespace)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource
    id
    string

    Id: Fully qualified resource ID for the resource. E.g. “/​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
    NamespaceProperties_STATUS

    Properties: Represents namespace properties.
    sku
    Sku_STATUS

    Sku: The Sku description for a namespace
    systemData
    SystemData_STATUS

    SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.
    tags
    map[string]string

    Tags: Resource tags.
    type
    string

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

    Namespace_Spec

    (Appears on:Namespace)

    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: The geo-location where the resource lives
    operatorSpec
    NamespaceOperatorSpec

    OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
    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
    properties
    NamespaceProperties

    Properties: Represents namespace properties.
    sku
    Sku

    Sku: The Sku description for a namespace
    tags
    map[string]string

    Tags: Resource tags.

    NamespacesAuthorizationRule

    Generator information: - Generated from: /notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.NotificationHubs/​namespaces/​{namespaceName}/​authorizationRules/​{authorizationRuleName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta     		Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    NamespacesAuthorizationRule_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: Deprecated - only for compatibility.
    operatorSpec
    NamespacesAuthorizationRuleOperatorSpec

    OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
    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 notificationhubs.azure.com/Namespace resource
    properties
    SharedAccessAuthorizationRuleProperties

    Properties: SharedAccessAuthorizationRule properties.
    tags
    map[string]string

    Tags: Deprecated - only for compatibility.
    status
    NamespacesAuthorizationRule_STATUS

    NamespacesAuthorizationRuleOperatorSpec

    (Appears on:NamespacesAuthorizationRule_Spec)

    Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

    Field Description
    configMapExpressions
    []genruntime/core.DestinationExpression

    ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
    secretExpressions
    []genruntime/core.DestinationExpression

    SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

    NamespacesAuthorizationRule_STATUS

    (Appears on:NamespacesAuthorizationRule)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource
    id
    string

    Id: Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}”

    location
    string

    Location: Deprecated - only for compatibility.
    name
    string

    Name: The name of the resource
    properties
    SharedAccessAuthorizationRuleProperties_STATUS

    Properties: SharedAccessAuthorizationRule properties.
    systemData
    SystemData_STATUS

    SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.
    tags
    map[string]string

    Tags: Deprecated - only for compatibility.
    type
    string

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

    NamespacesAuthorizationRule_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: Deprecated - only for compatibility.
    operatorSpec
    NamespacesAuthorizationRuleOperatorSpec

    OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
    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 notificationhubs.azure.com/Namespace resource
    properties
    SharedAccessAuthorizationRuleProperties

    Properties: SharedAccessAuthorizationRule properties.
    tags
    map[string]string

    Tags: Deprecated - only for compatibility.

    NetworkAcls

    (Appears on:NamespaceProperties)

    A collection of network authorization rules.

    Field Description
    ipRules
    []IpRule

    IpRules: List of IP rules.
    publicNetworkRule
    PublicInternetAuthorizationRule

    PublicNetworkRule: A default (public Internet) network authorization rule, which contains rights if no other network rule matches.

    NetworkAcls_STATUS

    (Appears on:NamespaceProperties_STATUS)

    A collection of network authorization rules.

    Field Description
    ipRules
    []IpRule_STATUS

    IpRules: List of IP rules.
    publicNetworkRule
    PublicInternetAuthorizationRule_STATUS

    PublicNetworkRule: A default (public Internet) network authorization rule, which contains rights if no other network rule matches.

    NotificationHub

    Generator information: - Generated from: /notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.NotificationHubs/​namespaces/​{namespaceName}/​notificationHubs/​{notificationHubName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta     		Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    NotificationHub_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: The geo-location where the resource lives
    operatorSpec
    NotificationHubOperatorSpec

    OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
    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 notificationhubs.azure.com/Namespace resource
    properties
    NotificationHubProperties

    Properties: NotificationHub properties.
    sku
    Sku

    Sku: The Sku description for a namespace
    tags
    map[string]string

    Tags: Resource tags.
    status
    NotificationHub_STATUS

    NotificationHubOperatorSecrets

    (Appears on:NotificationHubOperatorSpec)

    Field Description
    primaryConnectionString
    genruntime.SecretDestination

    PrimaryConnectionString: indicates where the PrimaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure.
    primaryKey
    genruntime.SecretDestination

    PrimaryKey: indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure.
    secondaryConnectionString
    genruntime.SecretDestination

    SecondaryConnectionString: indicates where the SecondaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure.
    secondaryKey
    genruntime.SecretDestination

    SecondaryKey: indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure.

    NotificationHubOperatorSpec

    (Appears on:NotificationHub_Spec)

    Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

    Field Description
    configMapExpressions
    []genruntime/core.DestinationExpression

    ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
    secretExpressions
    []genruntime/core.DestinationExpression

    SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).
    secrets
    NotificationHubOperatorSecrets

    Secrets: configures where to place Azure generated secrets.

    NotificationHubProperties

    (Appears on:NotificationHub_Spec)

    NotificationHub properties.

    Field Description
    admCredential
    AdmCredential

    AdmCredential: Description of a NotificationHub AdmCredential.
    apnsCredential
    ApnsCredential

    ApnsCredential: Description of a NotificationHub ApnsCredential.
    baiduCredential
    BaiduCredential

    BaiduCredential: Description of a NotificationHub BaiduCredential.
    browserCredential
    BrowserCredential

    BrowserCredential: Description of a NotificationHub BrowserCredential.
    gcmCredential
    GcmCredential

    GcmCredential: Description of a NotificationHub GcmCredential.
    mpnsCredential
    MpnsCredential

    MpnsCredential: Description of a NotificationHub MpnsCredential.
    name
    string

    Name: Gets or sets the NotificationHub name.
    registrationTtl
    string

    RegistrationTtl: Gets or sets the RegistrationTtl of the created NotificationHub
    wnsCredential
    WnsCredential

    WnsCredential: Description of a NotificationHub WnsCredential.
    xiaomiCredential
    XiaomiCredential

    XiaomiCredential: Description of a NotificationHub XiaomiCredential.

    NotificationHubProperties_STATUS

    (Appears on:NotificationHub_STATUS)

    NotificationHub properties.

    Field Description
    admCredential
    AdmCredential_STATUS

    AdmCredential: Description of a NotificationHub AdmCredential.
    apnsCredential
    ApnsCredential_STATUS

    ApnsCredential: Description of a NotificationHub ApnsCredential.
    authorizationRules
    []SharedAccessAuthorizationRuleProperties_STATUS

    AuthorizationRules: Gets or sets the AuthorizationRules of the created NotificationHub
    baiduCredential
    BaiduCredential_STATUS

    BaiduCredential: Description of a NotificationHub BaiduCredential.
    browserCredential
    BrowserCredential_STATUS

    BrowserCredential: Description of a NotificationHub BrowserCredential.
    dailyMaxActiveDevices
    int
    gcmCredential
    GcmCredential_STATUS

    GcmCredential: Description of a NotificationHub GcmCredential.
    mpnsCredential
    MpnsCredential_STATUS

    MpnsCredential: Description of a NotificationHub MpnsCredential.
    name
    string

    Name: Gets or sets the NotificationHub name.
    registrationTtl
    string

    RegistrationTtl: Gets or sets the RegistrationTtl of the created NotificationHub
    wnsCredential
    WnsCredential_STATUS

    WnsCredential: Description of a NotificationHub WnsCredential.
    xiaomiCredential
    XiaomiCredential_STATUS

    XiaomiCredential: Description of a NotificationHub XiaomiCredential.

    NotificationHub_STATUS

    (Appears on:NotificationHub)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource
    id
    string

    Id: Fully qualified resource ID for the resource. E.g. “/​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
    NotificationHubProperties_STATUS

    Properties: NotificationHub properties.
    sku
    Sku_STATUS

    Sku: The Sku description for a namespace
    systemData
    SystemData_STATUS

    SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.
    tags
    map[string]string

    Tags: Resource tags.
    type
    string

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

    NotificationHub_Spec

    (Appears on:NotificationHub)

    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: The geo-location where the resource lives
    operatorSpec
    NotificationHubOperatorSpec

    OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
    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 notificationhubs.azure.com/Namespace resource
    properties
    NotificationHubProperties

    Properties: NotificationHub properties.
    sku
    Sku

    Sku: The Sku description for a namespace
    tags
    map[string]string

    Tags: Resource tags.

    NotificationHubsAuthorizationRule

    Generator information: - Generated from: /notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.NotificationHubs/​namespaces/​{namespaceName}/​notificationHubs/​{notificationHubName}/​authorizationRules/​{authorizationRuleName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta     		Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    NotificationHubsAuthorizationRule_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: Deprecated - only for compatibility.
    operatorSpec
    NotificationHubsAuthorizationRuleOperatorSpec

    OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
    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 notificationhubs.azure.com/NotificationHub resource
    properties
    SharedAccessAuthorizationRuleProperties

    Properties: SharedAccessAuthorizationRule properties.
    tags
    map[string]string

    Tags: Deprecated - only for compatibility.
    status
    NotificationHubsAuthorizationRule_STATUS

    NotificationHubsAuthorizationRuleOperatorSpec

    (Appears on:NotificationHubsAuthorizationRule_Spec)

    Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

    Field Description
    configMapExpressions
    []genruntime/core.DestinationExpression

    ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
    secretExpressions
    []genruntime/core.DestinationExpression

    SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

    NotificationHubsAuthorizationRule_STATUS

    (Appears on:NotificationHubsAuthorizationRule)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource
    id
    string

    Id: Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}”

    location
    string

    Location: Deprecated - only for compatibility.
    name
    string

    Name: The name of the resource
    properties
    SharedAccessAuthorizationRuleProperties_STATUS

    Properties: SharedAccessAuthorizationRule properties.
    systemData
    SystemData_STATUS

    SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.
    tags
    map[string]string

    Tags: Deprecated - only for compatibility.
    type
    string

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

    NotificationHubsAuthorizationRule_Spec

    (Appears on:NotificationHubsAuthorizationRule)

    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: Deprecated - only for compatibility.
    operatorSpec
    NotificationHubsAuthorizationRuleOperatorSpec

    OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
    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 notificationhubs.azure.com/NotificationHub resource
    properties
    SharedAccessAuthorizationRuleProperties

    Properties: SharedAccessAuthorizationRule properties.
    tags
    map[string]string

    Tags: Deprecated - only for compatibility.

    OperationProvisioningState_STATUS (string alias)

    (Appears on:NamespaceProperties_STATUS)

    Defines values for OperationProvisioningState.

    Value Description

    "Canceled"

    "Disabled"

    "Failed"

    "InProgress"

    "Pending"

    "Succeeded"

    "Unknown"

    PnsCredentials

    (Appears on:NamespaceProperties)

    Collection of Notification Hub or Notification Hub Namespace PNS credentials.

    Field Description
    admCredential
    AdmCredential

    AdmCredential: Description of a NotificationHub AdmCredential.
    apnsCredential
    ApnsCredential

    ApnsCredential: Description of a NotificationHub ApnsCredential.
    baiduCredential
    BaiduCredential

    BaiduCredential: Description of a NotificationHub BaiduCredential.
    browserCredential
    BrowserCredential

    BrowserCredential: Description of a NotificationHub BrowserCredential.
    gcmCredential
    GcmCredential

    GcmCredential: Description of a NotificationHub GcmCredential.
    mpnsCredential
    MpnsCredential

    MpnsCredential: Description of a NotificationHub MpnsCredential.
    wnsCredential
    WnsCredential

    WnsCredential: Description of a NotificationHub WnsCredential.
    xiaomiCredential
    XiaomiCredential

    XiaomiCredential: Description of a NotificationHub XiaomiCredential.

    PnsCredentials_STATUS

    (Appears on:NamespaceProperties_STATUS)

    Collection of Notification Hub or Notification Hub Namespace PNS credentials.

    Field Description
    admCredential
    AdmCredential_STATUS

    AdmCredential: Description of a NotificationHub AdmCredential.
    apnsCredential
    ApnsCredential_STATUS

    ApnsCredential: Description of a NotificationHub ApnsCredential.
    baiduCredential
    BaiduCredential_STATUS

    BaiduCredential: Description of a NotificationHub BaiduCredential.
    browserCredential
    BrowserCredential_STATUS

    BrowserCredential: Description of a NotificationHub BrowserCredential.
    gcmCredential
    GcmCredential_STATUS

    GcmCredential: Description of a NotificationHub GcmCredential.
    mpnsCredential
    MpnsCredential_STATUS

    MpnsCredential: Description of a NotificationHub MpnsCredential.
    wnsCredential
    WnsCredential_STATUS

    WnsCredential: Description of a NotificationHub WnsCredential.
    xiaomiCredential
    XiaomiCredential_STATUS

    XiaomiCredential: Description of a NotificationHub XiaomiCredential.

    PrivateEndpointConnectionResource_STATUS

    (Appears on:NamespaceProperties_STATUS)

    Represents a Private Endpoint Connection ARM resource - a sub-resource of Notification Hubs namespace.

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}”

    PublicInternetAuthorizationRule

    (Appears on:NetworkAcls)

    A default (public Internet) network authorization rule, which contains rights if no other network rule matches.

    Field Description
    rights
    []AccessRights

    Rights: List of access rights.

    PublicInternetAuthorizationRule_STATUS

    (Appears on:NetworkAcls_STATUS)

    A default (public Internet) network authorization rule, which contains rights if no other network rule matches.

    Field Description
    rights
    []AccessRights_STATUS

    Rights: List of access rights.

    PublicNetworkAccess (string alias)

    (Appears on:NamespaceProperties)

    Type of public network access.

    Value Description

    "Disabled"

    "Enabled"

    PublicNetworkAccess_STATUS (string alias)

    (Appears on:NamespaceProperties_STATUS)

    Type of public network access.

    Value Description

    "Disabled"

    "Enabled"

    ReplicationRegion (string alias)

    (Appears on:NamespaceProperties)

    Allowed replication region

    Value Description

    "AustraliaEast"

    "BrazilSouth"

    "Default"

    "None"

    "NorthEurope"

    "SouthAfricaNorth"

    "SouthEastAsia"

    "WestUs2"

    ReplicationRegion_STATUS (string alias)

    (Appears on:NamespaceProperties_STATUS)

    Allowed replication region

    Value Description

    "AustraliaEast"

    "BrazilSouth"

    "Default"

    "None"

    "NorthEurope"

    "SouthAfricaNorth"

    "SouthEastAsia"

    "WestUs2"

    SharedAccessAuthorizationRuleProperties

    (Appears on:NamespacesAuthorizationRule_Spec, NotificationHubsAuthorizationRule_Spec)

    SharedAccessAuthorizationRule properties.

    Field Description
    rights
    []AccessRights

    Rights: Gets or sets the rights associated with the rule.

    SharedAccessAuthorizationRuleProperties_STATUS

    (Appears on:NamespacesAuthorizationRule_STATUS, NotificationHubProperties_STATUS, NotificationHubsAuthorizationRule_STATUS)

    SharedAccessAuthorizationRule properties.

    Field Description
    claimType
    string

    ClaimType: Gets a string that describes the claim type
    claimValue
    string

    ClaimValue: Gets a string that describes the claim value
    createdTime
    string

    CreatedTime: Gets the created time for this rule
    keyName
    string

    KeyName: Gets a string that describes the authorization rule.
    modifiedTime
    string

    ModifiedTime: Gets the last modified time for this rule
    revision
    int

    Revision: Gets the revision number for the rule
    rights
    []AccessRights_STATUS

    Rights: Gets or sets the rights associated with the rule.

    Sku

    (Appears on:Namespace_Spec, NotificationHub_Spec)

    The Sku description for a namespace

    Field Description
    capacity
    int

    Capacity: Gets or sets the capacity of the resource
    family
    string

    Family: Gets or sets the Sku Family
    name
    SkuName

    Name: Namespace SKU name.
    size
    string

    Size: Gets or sets the Sku size
    tier
    string

    Tier: Gets or sets the tier of particular sku

    SkuName (string alias)

    (Appears on:Sku)

    Namespace SKU name.

    Value Description

    "Basic"

    "Free"

    "Standard"

    SkuName_STATUS (string alias)

    (Appears on:Sku_STATUS)

    Namespace SKU name.

    Value Description

    "Basic"

    "Free"

    "Standard"

    Sku_STATUS

    (Appears on:Namespace_STATUS, NotificationHub_STATUS)

    The Sku description for a namespace

    Field Description
    capacity
    int

    Capacity: Gets or sets the capacity of the resource
    family
    string

    Family: Gets or sets the Sku Family
    name
    SkuName_STATUS

    Name: Namespace SKU name.
    size
    string

    Size: Gets or sets the Sku size
    tier
    string

    Tier: Gets or sets the tier of particular sku

    SystemData_CreatedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_STATUS

    (Appears on:Namespace_STATUS, NamespacesAuthorizationRule_STATUS, NotificationHub_STATUS, NotificationHubsAuthorizationRule_STATUS)

    Metadata pertaining to creation and last modification of the resource.

    Field Description
    createdAt
    string

    CreatedAt: The timestamp of resource creation (UTC).
    createdBy
    string

    CreatedBy: The identity that created the resource.
    createdByType
    SystemData_CreatedByType_STATUS

    CreatedByType: The type of identity that created the resource.
    lastModifiedAt
    string

    LastModifiedAt: The timestamp of resource last modification (UTC)
    lastModifiedBy
    string

    LastModifiedBy: The identity that last modified the resource.
    lastModifiedByType
    SystemData_LastModifiedByType_STATUS

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

    WnsCredential

    (Appears on:NotificationHubProperties, PnsCredentials)

    Description of a NotificationHub WnsCredential.

    Field Description
    properties
    WnsCredentialProperties

    Properties: Description of a NotificationHub WnsCredential.

    WnsCredentialProperties

    (Appears on:WnsCredential)

    Description of a NotificationHub WnsCredential.

    Field Description
    certificateKey
    genruntime.SecretReference

    CertificateKey: Ges or sets the WNS Certificate Key.
    packageSid
    genruntime.SecretReference

    PackageSid: Gets or sets the package ID for this credential.
    secretKey
    genruntime.SecretReference

    SecretKey: Gets or sets the secret key.
    windowsLiveEndpoint
    genruntime.SecretReference

    WindowsLiveEndpoint: Gets or sets the Windows Live endpoint.
    wnsCertificate
    genruntime.SecretReference

    WnsCertificate: Gets or sets the WNS Certificate.

    WnsCredentialProperties_STATUS

    (Appears on:WnsCredential_STATUS)

    Description of a NotificationHub WnsCredential.

    WnsCredential_STATUS

    (Appears on:NotificationHubProperties_STATUS, PnsCredentials_STATUS)

    Description of a NotificationHub WnsCredential.

    Field Description
    properties
    WnsCredentialProperties_STATUS

    Properties: Description of a NotificationHub WnsCredential.

    XiaomiCredential

    (Appears on:NotificationHubProperties, PnsCredentials)

    Description of a NotificationHub XiaomiCredential.

    Field Description
    properties
    XiaomiCredentialProperties

    Properties: Description of a NotificationHub XiaomiCredentialProperties.

    XiaomiCredentialProperties

    (Appears on:XiaomiCredential)

    Description of a NotificationHub XiaomiCredentialProperties.

    Field Description
    appSecret
    genruntime.SecretReference

    AppSecret: Gets or sets app secret.
    endpoint
    genruntime.SecretReference

    Endpoint: Gets or sets xiaomi service endpoint.

    XiaomiCredentialProperties_STATUS

    (Appears on:XiaomiCredential_STATUS)

    Description of a NotificationHub XiaomiCredentialProperties.

    XiaomiCredential_STATUS

    (Appears on:NotificationHubProperties_STATUS, PnsCredentials_STATUS)

    Description of a NotificationHub XiaomiCredential.

    Field Description
    properties
    XiaomiCredentialProperties_STATUS

    Properties: Description of a NotificationHub XiaomiCredentialProperties.

    ZoneRedundancyPreference (string alias)

    (Appears on:NamespaceProperties)

    Namespace SKU name.

    Value Description

    "Disabled"

    "Enabled"

    ZoneRedundancyPreference_STATUS (string alias)

    (Appears on:NamespaceProperties_STATUS)

    Namespace SKU name.

    Value Description

    "Disabled"

    "Enabled"