notificationhubs.azure.com/v1api20230901
APIVersion
| Value | Description |
|---|---|
| “2023-09-01” |
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}
Used by: NamespaceList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Namespace_Spec Optional |
|
| status | Namespace_STATUS Optional |
Namespace_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| location | The geo-location where the resource lives | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespaceOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| properties | Represents namespace properties. | NamespaceProperties Optional |
| sku | The Sku description for a namespace | Sku Required |
| tags | Resource tags. | map[string]string Optional |
Namespace_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| properties | Represents namespace properties. | NamespaceProperties_STATUS Optional |
| sku | The Sku description for a namespace | Sku_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
NamespaceList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Namespace[] Optional |
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}
Used by: NamespacesAuthorizationRuleList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | NamespacesAuthorizationRule_Spec Optional |
|
| status | NamespacesAuthorizationRule_STATUS Optional |
NamespacesAuthorizationRule_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| location | Deprecated - only for compatibility. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespacesAuthorizationRuleOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a notificationhubs.azure.com/Namespace resource | genruntime.KnownResourceReference Required |
| properties | SharedAccessAuthorizationRule properties. | SharedAccessAuthorizationRuleProperties Optional |
| tags | Deprecated - only for compatibility. | map[string]string Optional |
NamespacesAuthorizationRule_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| location | Deprecated - only for compatibility. | string Optional |
| name | The name of the resource | string Optional |
| properties | SharedAccessAuthorizationRule properties. | SharedAccessAuthorizationRuleProperties_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Deprecated - only for compatibility. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
NamespacesAuthorizationRuleList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | NamespacesAuthorizationRule[] Optional |
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}
Used by: NotificationHubList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | NotificationHub_Spec Optional |
|
| status | NotificationHub_STATUS Optional |
NotificationHub_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| location | The geo-location where the resource lives | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NotificationHubOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a notificationhubs.azure.com/Namespace resource | genruntime.KnownResourceReference Required |
| properties | NotificationHub properties. | NotificationHubProperties Optional |
| sku | The Sku description for a namespace | Sku Optional |
| tags | Resource tags. | map[string]string Optional |
NotificationHub_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| properties | NotificationHub properties. | NotificationHubProperties_STATUS Optional |
| sku | The Sku description for a namespace | Sku_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
NotificationHubList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | NotificationHub[] Optional |
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}
Used by: NotificationHubsAuthorizationRuleList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | NotificationHubsAuthorizationRule_Spec Optional |
|
| status | NotificationHubsAuthorizationRule_STATUS Optional |
NotificationHubsAuthorizationRule_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| location | Deprecated - only for compatibility. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NotificationHubsAuthorizationRuleOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a notificationhubs.azure.com/NotificationHub resource | genruntime.KnownResourceReference Required |
| properties | SharedAccessAuthorizationRule properties. | SharedAccessAuthorizationRuleProperties Optional |
| tags | Deprecated - only for compatibility. | map[string]string Optional |
NotificationHubsAuthorizationRule_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| location | Deprecated - only for compatibility. | string Optional |
| name | The name of the resource | string Optional |
| properties | SharedAccessAuthorizationRule properties. | SharedAccessAuthorizationRuleProperties_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Deprecated - only for compatibility. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
NotificationHubsAuthorizationRuleList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | NotificationHubsAuthorizationRule[] Optional |
Namespace_Spec
Used by: Namespace.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| location | The geo-location where the resource lives | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespaceOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| properties | Represents namespace properties. | NamespaceProperties Optional |
| sku | The Sku description for a namespace | Sku Required |
| tags | Resource tags. | map[string]string Optional |
Namespace_STATUS
Used by: Namespace.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| properties | Represents namespace properties. | NamespaceProperties_STATUS Optional |
| sku | The Sku description for a namespace | Sku_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
NamespacesAuthorizationRule_Spec
Used by: NamespacesAuthorizationRule.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| location | Deprecated - only for compatibility. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NamespacesAuthorizationRuleOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a notificationhubs.azure.com/Namespace resource | genruntime.KnownResourceReference Required |
| properties | SharedAccessAuthorizationRule properties. | SharedAccessAuthorizationRuleProperties Optional |
| tags | Deprecated - only for compatibility. | map[string]string Optional |
NamespacesAuthorizationRule_STATUS
Used by: NamespacesAuthorizationRule.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| location | Deprecated - only for compatibility. | string Optional |
| name | The name of the resource | string Optional |
| properties | SharedAccessAuthorizationRule properties. | SharedAccessAuthorizationRuleProperties_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Deprecated - only for compatibility. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
NotificationHub_Spec
Used by: NotificationHub.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| location | The geo-location where the resource lives | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NotificationHubOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a notificationhubs.azure.com/Namespace resource | genruntime.KnownResourceReference Required |
| properties | NotificationHub properties. | NotificationHubProperties Optional |
| sku | The Sku description for a namespace | Sku Optional |
| tags | Resource tags. | map[string]string Optional |
NotificationHub_STATUS
Used by: NotificationHub.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| properties | NotificationHub properties. | NotificationHubProperties_STATUS Optional |
| sku | The Sku description for a namespace | Sku_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
NotificationHubsAuthorizationRule_Spec
Used by: NotificationHubsAuthorizationRule.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| location | Deprecated - only for compatibility. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | NotificationHubsAuthorizationRuleOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a notificationhubs.azure.com/NotificationHub resource | genruntime.KnownResourceReference Required |
| properties | SharedAccessAuthorizationRule properties. | SharedAccessAuthorizationRuleProperties Optional |
| tags | Deprecated - only for compatibility. | map[string]string Optional |
NotificationHubsAuthorizationRule_STATUS
Used by: NotificationHubsAuthorizationRule.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| location | Deprecated - only for compatibility. | string Optional |
| name | The name of the resource | string Optional |
| properties | SharedAccessAuthorizationRule properties. | SharedAccessAuthorizationRuleProperties_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Deprecated - only for compatibility. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
NamespaceOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Namespace_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| configMaps | configures where to place operator written ConfigMaps. | NamespaceOperatorConfigMaps Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
| secrets | configures where to place Azure generated secrets. | NamespaceOperatorSecrets Optional |
NamespaceProperties
Represents namespace properties.
Used by: Namespace_Spec.
| Property | Description | Type |
|---|---|---|
| dataCenter | Deprecated. | string Optional |
| namespaceType | Defines values for NamespaceType. | NamespaceType Optional |
| networkAcls | A collection of network authorization rules. | NetworkAcls Optional |
| pnsCredentials | Collection of Notification Hub or Notification Hub Namespace PNS credentials. | PnsCredentials Optional |
| publicNetworkAccess | Type of public network access. | PublicNetworkAccess Optional |
| replicationRegion | Allowed replication region | ReplicationRegion Optional |
| scaleUnit | Gets or sets scaleUnit where the namespace gets created | string Optional |
| zoneRedundancy | Namespace SKU name. | ZoneRedundancyPreference Optional |
NamespaceProperties_STATUS
Represents namespace properties.
Used by: Namespace_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | Time when the namespace was created. | string Optional |
| critical | Gets or sets whether or not the namespace is set as Critical. | bool Optional |
| dataCenter | Deprecated. | string Optional |
| enabled | Gets or sets whether or not the namespace is currently enabled. | bool Optional |
| metricId | Azure Insights Metrics id. | string Optional |
| name | Name of the Notification Hubs namespace. This is immutable property, set automatically by the service when the namespace is created. | string Optional |
| namespaceType | Defines values for NamespaceType. | NamespaceType_STATUS Optional |
| networkAcls | A collection of network authorization rules. | NetworkAcls_STATUS Optional |
| pnsCredentials | Collection of Notification Hub or Notification Hub Namespace PNS credentials. | PnsCredentials_STATUS Optional |
| privateEndpointConnections | Private Endpoint Connections for namespace | PrivateEndpointConnectionResource_STATUS[] Optional |
| provisioningState | Defines values for OperationProvisioningState. | OperationProvisioningState_STATUS Optional |
| publicNetworkAccess | Type of public network access. | PublicNetworkAccess_STATUS Optional |
| region | Region. The value is always set to the same value as Namespace.Location, so we are deprecating this property. | string Optional |
| replicationRegion | Allowed replication region | ReplicationRegion_STATUS Optional |
| scaleUnit | Gets or sets scaleUnit where the namespace gets created | string Optional |
| serviceBusEndpoint | Gets or sets endpoint you can use to perform NotificationHub operations. | string Optional |
| status | Namespace status. | NamespaceStatus_STATUS Optional |
| subscriptionId | Namespace subscription id. | string Optional |
| updatedAt | Time when the namespace was updated. | string Optional |
| zoneRedundancy | Namespace SKU name. | ZoneRedundancyPreference_STATUS Optional |
NamespacesAuthorizationRuleOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: NamespacesAuthorizationRule_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
NotificationHubOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: NotificationHub_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
| secrets | configures where to place Azure generated secrets. | NotificationHubOperatorSecrets Optional |
NotificationHubProperties
NotificationHub properties.
Used by: NotificationHub_Spec.
| Property | Description | Type |
|---|---|---|
| admCredential | Description of a NotificationHub AdmCredential. | AdmCredential Optional |
| apnsCredential | Description of a NotificationHub ApnsCredential. | ApnsCredential Optional |
| baiduCredential | Description of a NotificationHub BaiduCredential. | BaiduCredential Optional |
| browserCredential | Description of a NotificationHub BrowserCredential. | BrowserCredential Optional |
| gcmCredential | Description of a NotificationHub GcmCredential. | GcmCredential Optional |
| mpnsCredential | Description of a NotificationHub MpnsCredential. | MpnsCredential Optional |
| name | Gets or sets the NotificationHub name. | string Optional |
| registrationTtl | Gets or sets the RegistrationTtl of the created NotificationHub | string Optional |
| wnsCredential | Description of a NotificationHub WnsCredential. | WnsCredential Optional |
| xiaomiCredential | Description of a NotificationHub XiaomiCredential. | XiaomiCredential Optional |
NotificationHubProperties_STATUS
NotificationHub properties.
Used by: NotificationHub_STATUS.
| Property | Description | Type |
|---|---|---|
| admCredential | Description of a NotificationHub AdmCredential. | AdmCredential_STATUS Optional |
| apnsCredential | Description of a NotificationHub ApnsCredential. | ApnsCredential_STATUS Optional |
| authorizationRules | Gets or sets the AuthorizationRules of the created NotificationHub | SharedAccessAuthorizationRuleProperties_STATUS[] Optional |
| baiduCredential | Description of a NotificationHub BaiduCredential. | BaiduCredential_STATUS Optional |
| browserCredential | Description of a NotificationHub BrowserCredential. | BrowserCredential_STATUS Optional |
| dailyMaxActiveDevices | int Optional |
|
| gcmCredential | Description of a NotificationHub GcmCredential. | GcmCredential_STATUS Optional |
| mpnsCredential | Description of a NotificationHub MpnsCredential. | MpnsCredential_STATUS Optional |
| name | Gets or sets the NotificationHub name. | string Optional |
| registrationTtl | Gets or sets the RegistrationTtl of the created NotificationHub | string Optional |
| wnsCredential | Description of a NotificationHub WnsCredential. | WnsCredential_STATUS Optional |
| xiaomiCredential | Description of a NotificationHub XiaomiCredential. | XiaomiCredential_STATUS Optional |
NotificationHubsAuthorizationRuleOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: NotificationHubsAuthorizationRule_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
SharedAccessAuthorizationRuleProperties
SharedAccessAuthorizationRule properties.
Used by: NamespacesAuthorizationRule_Spec, and NotificationHubsAuthorizationRule_Spec.
| Property | Description | Type |
|---|---|---|
| rights | Gets or sets the rights associated with the rule. | AccessRights[] Required |
SharedAccessAuthorizationRuleProperties_STATUS
SharedAccessAuthorizationRule properties.
Used by: NamespacesAuthorizationRule_STATUS, NotificationHubProperties_STATUS, and NotificationHubsAuthorizationRule_STATUS.
| Property | Description | Type |
|---|---|---|
| claimType | Gets a string that describes the claim type | string Optional |
| claimValue | Gets a string that describes the claim value | string Optional |
| createdTime | Gets the created time for this rule | string Optional |
| keyName | Gets a string that describes the authorization rule. | string Optional |
| modifiedTime | Gets the last modified time for this rule | string Optional |
| revision | Gets the revision number for the rule | int Optional |
| rights | Gets or sets the rights associated with the rule. | AccessRights_STATUS[] Optional |
Sku
The Sku description for a namespace
Used by: Namespace_Spec, and NotificationHub_Spec.
| Property | Description | Type |
|---|---|---|
| capacity | Gets or sets the capacity of the resource | int Optional |
| family | Gets or sets the Sku Family | string Optional |
| name | Namespace SKU name. | SkuName Required |
| size | Gets or sets the Sku size | string Optional |
| tier | Gets or sets the tier of particular sku | string Optional |
Sku_STATUS
The Sku description for a namespace
Used by: Namespace_STATUS, and NotificationHub_STATUS.
| Property | Description | Type |
|---|---|---|
| capacity | Gets or sets the capacity of the resource | int Optional |
| family | Gets or sets the Sku Family | string Optional |
| name | Namespace SKU name. | SkuName_STATUS Optional |
| size | Gets or sets the Sku size | string Optional |
| tier | Gets or sets the tier of particular sku | string Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: Namespace_STATUS, NamespacesAuthorizationRule_STATUS, NotificationHub_STATUS, and NotificationHubsAuthorizationRule_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
| lastModifiedAt | The timestamp of resource last modification (UTC) | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
AccessRights
Defines values for AccessRights.
Used by: IpRule, PublicInternetAuthorizationRule, and SharedAccessAuthorizationRuleProperties.
| Value | Description |
|---|---|
| “Listen” | |
| “Manage” | |
| “Send” |
AccessRights_STATUS
Defines values for AccessRights.
Used by: IpRule_STATUS, PublicInternetAuthorizationRule_STATUS, and SharedAccessAuthorizationRuleProperties_STATUS.
| Value | Description |
|---|---|
| “Listen” | |
| “Manage” | |
| “Send” |
AdmCredential
Description of a NotificationHub AdmCredential.
Used by: NotificationHubProperties, and PnsCredentials.
| Property | Description | Type |
|---|---|---|
| properties | Description of a NotificationHub AdmCredential. | AdmCredentialProperties Required |
AdmCredential_STATUS
Description of a NotificationHub AdmCredential.
Used by: NotificationHubProperties_STATUS, and PnsCredentials_STATUS.
| Property | Description | Type |
|---|---|---|
| properties | Description of a NotificationHub AdmCredential. | AdmCredentialProperties_STATUS Optional |
ApnsCredential
Description of a NotificationHub ApnsCredential.
Used by: NotificationHubProperties, and PnsCredentials.
| Property | Description | Type |
|---|---|---|
| properties | Description of a NotificationHub ApnsCredential. | ApnsCredentialProperties Required |
ApnsCredential_STATUS
Description of a NotificationHub ApnsCredential.
Used by: NotificationHubProperties_STATUS, and PnsCredentials_STATUS.
| Property | Description | Type |
|---|---|---|
| properties | Description of a NotificationHub ApnsCredential. | ApnsCredentialProperties_STATUS Optional |
BaiduCredential
Description of a NotificationHub BaiduCredential.
Used by: NotificationHubProperties, and PnsCredentials.
| Property | Description | Type |
|---|---|---|
| properties | Description of a NotificationHub BaiduCredential. | BaiduCredentialProperties Required |
BaiduCredential_STATUS
Description of a NotificationHub BaiduCredential.
Used by: NotificationHubProperties_STATUS, and PnsCredentials_STATUS.
| Property | Description | Type |
|---|---|---|
| properties | Description of a NotificationHub BaiduCredential. | BaiduCredentialProperties_STATUS Optional |
BrowserCredential
Description of a NotificationHub BrowserCredential.
Used by: NotificationHubProperties, and PnsCredentials.
| Property | Description | Type |
|---|---|---|
| properties | Description of a NotificationHub BrowserCredential. | BrowserCredentialProperties Required |
BrowserCredential_STATUS
Description of a NotificationHub BrowserCredential.
Used by: NotificationHubProperties_STATUS, and PnsCredentials_STATUS.
| Property | Description | Type |
|---|---|---|
| properties | Description of a NotificationHub BrowserCredential. | BrowserCredentialProperties_STATUS Optional |
GcmCredential
Description of a NotificationHub GcmCredential.
Used by: NotificationHubProperties, and PnsCredentials.
| Property | Description | Type |
|---|---|---|
| properties | Description of a NotificationHub GcmCredential. | GcmCredentialProperties Required |
GcmCredential_STATUS
Description of a NotificationHub GcmCredential.
Used by: NotificationHubProperties_STATUS, and PnsCredentials_STATUS.
| Property | Description | Type |
|---|---|---|
| properties | Description of a NotificationHub GcmCredential. | GcmCredentialProperties_STATUS Optional |
MpnsCredential
Description of a NotificationHub MpnsCredential.
Used by: NotificationHubProperties, and PnsCredentials.
| Property | Description | Type |
|---|---|---|
| properties | Description of a NotificationHub MpnsCredential. | MpnsCredentialProperties Required |
MpnsCredential_STATUS
Description of a NotificationHub MpnsCredential.
Used by: NotificationHubProperties_STATUS, and PnsCredentials_STATUS.
| Property | Description | Type |
|---|---|---|
| properties | Description of a NotificationHub MpnsCredential. | MpnsCredentialProperties_STATUS Optional |
NamespaceOperatorConfigMaps
Used by: NamespaceOperatorSpec.
| Property | Description | Type |
|---|---|---|
| serviceBusEndpoint | indicates where the ServiceBusEndpoint config map should be placed. If omitted, no config map will be created. | genruntime.ConfigMapDestination Optional |
NamespaceOperatorSecrets
Used by: NamespaceOperatorSpec.
| Property | Description | Type |
|---|---|---|
| primaryConnectionString | indicates where the PrimaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| primaryKey | indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryConnectionString | indicates where the SecondaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryKey | indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
NamespaceStatus_STATUS
Namespace status.
Used by: NamespaceProperties_STATUS.
| Value | Description |
|---|---|
| “Created” | |
| “Creating” | |
| “Deleting” | |
| “Suspended” |
NamespaceType
Defines values for NamespaceType.
Used by: NamespaceProperties.
| Value | Description |
|---|---|
| “Messaging” | |
| “NotificationHub” |
NamespaceType_STATUS
Defines values for NamespaceType.
Used by: NamespaceProperties_STATUS.
| Value | Description |
|---|---|
| “Messaging” | |
| “NotificationHub” |
NetworkAcls
A collection of network authorization rules.
Used by: NamespaceProperties.
| Property | Description | Type |
|---|---|---|
| ipRules | List of IP rules. | IpRule[] Optional |
| publicNetworkRule | A default (public Internet) network authorization rule, which contains rights if no other network rule matches. | PublicInternetAuthorizationRule Optional |
NetworkAcls_STATUS
A collection of network authorization rules.
Used by: NamespaceProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| ipRules | List of IP rules. | IpRule_STATUS[] Optional |
| publicNetworkRule | A default (public Internet) network authorization rule, which contains rights if no other network rule matches. | PublicInternetAuthorizationRule_STATUS Optional |
NotificationHubOperatorSecrets
Used by: NotificationHubOperatorSpec.
| Property | Description | Type |
|---|---|---|
| primaryConnectionString | indicates where the PrimaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| primaryKey | indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryConnectionString | indicates where the SecondaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryKey | indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
OperationProvisioningState_STATUS
Defines values for OperationProvisioningState.
Used by: NamespaceProperties_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Disabled” | |
| “Failed” | |
| “InProgress” | |
| “Pending” | |
| “Succeeded” | |
| “Unknown” |
PnsCredentials
Collection of Notification Hub or Notification Hub Namespace PNS credentials.
Used by: NamespaceProperties.
| Property | Description | Type |
|---|---|---|
| admCredential | Description of a NotificationHub AdmCredential. | AdmCredential Optional |
| apnsCredential | Description of a NotificationHub ApnsCredential. | ApnsCredential Optional |
| baiduCredential | Description of a NotificationHub BaiduCredential. | BaiduCredential Optional |
| browserCredential | Description of a NotificationHub BrowserCredential. | BrowserCredential Optional |
| gcmCredential | Description of a NotificationHub GcmCredential. | GcmCredential Optional |
| mpnsCredential | Description of a NotificationHub MpnsCredential. | MpnsCredential Optional |
| wnsCredential | Description of a NotificationHub WnsCredential. | WnsCredential Optional |
| xiaomiCredential | Description of a NotificationHub XiaomiCredential. | XiaomiCredential Optional |
PnsCredentials_STATUS
Collection of Notification Hub or Notification Hub Namespace PNS credentials.
Used by: NamespaceProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| admCredential | Description of a NotificationHub AdmCredential. | AdmCredential_STATUS Optional |
| apnsCredential | Description of a NotificationHub ApnsCredential. | ApnsCredential_STATUS Optional |
| baiduCredential | Description of a NotificationHub BaiduCredential. | BaiduCredential_STATUS Optional |
| browserCredential | Description of a NotificationHub BrowserCredential. | BrowserCredential_STATUS Optional |
| gcmCredential | Description of a NotificationHub GcmCredential. | GcmCredential_STATUS Optional |
| mpnsCredential | Description of a NotificationHub MpnsCredential. | MpnsCredential_STATUS Optional |
| wnsCredential | Description of a NotificationHub WnsCredential. | WnsCredential_STATUS Optional |
| xiaomiCredential | Description of a NotificationHub XiaomiCredential. | XiaomiCredential_STATUS Optional |
PrivateEndpointConnectionResource_STATUS
Represents a Private Endpoint Connection ARM resource - a sub-resource of Notification Hubs namespace.
Used by: NamespaceProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
PublicNetworkAccess
Type of public network access.
Used by: NamespaceProperties.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
PublicNetworkAccess_STATUS
Type of public network access.
Used by: NamespaceProperties_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
ReplicationRegion
Allowed replication region
Used by: NamespaceProperties.
| Value | Description |
|---|---|
| “AustraliaEast” | |
| “BrazilSouth” | |
| “Default” | |
| “None” | |
| “NorthEurope” | |
| “SouthAfricaNorth” | |
| “SouthEastAsia” | |
| “WestUs2” |
ReplicationRegion_STATUS
Allowed replication region
Used by: NamespaceProperties_STATUS.
| Value | Description |
|---|---|
| “AustraliaEast” | |
| “BrazilSouth” | |
| “Default” | |
| “None” | |
| “NorthEurope” | |
| “SouthAfricaNorth” | |
| “SouthEastAsia” | |
| “WestUs2” |
SkuName
Namespace SKU name.
Used by: Sku.
| Value | Description |
|---|---|
| “Basic” | |
| “Free” | |
| “Standard” |
SkuName_STATUS
Namespace SKU name.
Used by: Sku_STATUS.
| Value | Description |
|---|---|
| “Basic” | |
| “Free” | |
| “Standard” |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
WnsCredential
Description of a NotificationHub WnsCredential.
Used by: NotificationHubProperties, and PnsCredentials.
| Property | Description | Type |
|---|---|---|
| properties | Description of a NotificationHub WnsCredential. | WnsCredentialProperties Required |
WnsCredential_STATUS
Description of a NotificationHub WnsCredential.
Used by: NotificationHubProperties_STATUS, and PnsCredentials_STATUS.
| Property | Description | Type |
|---|---|---|
| properties | Description of a NotificationHub WnsCredential. | WnsCredentialProperties_STATUS Optional |
XiaomiCredential
Description of a NotificationHub XiaomiCredential.
Used by: NotificationHubProperties, and PnsCredentials.
| Property | Description | Type |
|---|---|---|
| properties | Description of a NotificationHub XiaomiCredentialProperties. | XiaomiCredentialProperties Required |
XiaomiCredential_STATUS
Description of a NotificationHub XiaomiCredential.
Used by: NotificationHubProperties_STATUS, and PnsCredentials_STATUS.
| Property | Description | Type |
|---|---|---|
| properties | Description of a NotificationHub XiaomiCredentialProperties. | XiaomiCredentialProperties_STATUS Optional |
ZoneRedundancyPreference
Namespace SKU name.
Used by: NamespaceProperties.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
ZoneRedundancyPreference_STATUS
Namespace SKU name.
Used by: NamespaceProperties_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
AdmCredentialProperties
Description of a NotificationHub AdmCredential.
Used by: AdmCredential.
| Property | Description | Type |
|---|---|---|
| authTokenUrl | Gets or sets the URL of the authorization token. | genruntime.SecretReference Required |
| clientId | Gets or sets the client identifier. | genruntime.SecretReference Required |
| clientSecret | Gets or sets the credential secret access key. | genruntime.SecretReference Required |
ApnsCredentialProperties
Description of a NotificationHub ApnsCredential.
Used by: ApnsCredential.
| Property | Description | Type |
|---|---|---|
| apnsCertificate | Gets or sets the APNS certificate. | genruntime.SecretReference Optional |
| appId | Gets or sets the issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account | genruntime.SecretReference Optional |
| appName | Gets or sets the name of the application | genruntime.SecretReference Optional |
| certificateKey | Gets or sets the certificate key. | genruntime.SecretReference Optional |
| endpoint | Gets or sets the endpoint of this credential. | genruntime.SecretReference Required |
| keyId | Gets or sets a 10-character key identifier (kid) key, obtained from your developer account | genruntime.SecretReference Optional |
| thumbprint | Gets or sets the APNS certificate Thumbprint | genruntime.SecretReference Optional |
| token | Gets or sets provider Authentication Token, obtained through your developer account | genruntime.SecretReference Optional |
BaiduCredentialProperties
Description of a NotificationHub BaiduCredential.
Used by: BaiduCredential.
| Property | Description | Type |
|---|---|---|
| baiduApiKey | Gets or sets baidu Api Key. | genruntime.SecretReference Required |
| baiduEndPoint | Gets or sets baidu Endpoint. | genruntime.SecretReference Required |
| baiduSecretKey | Gets or sets baidu Secret Key | genruntime.SecretReference Required |
BrowserCredentialProperties
Description of a NotificationHub BrowserCredential.
Used by: BrowserCredential.
| Property | Description | Type |
|---|---|---|
| subject | Gets or sets web push subject. | genruntime.SecretReference Required |
| vapidPrivateKey | Gets or sets VAPID private key. | genruntime.SecretReference Required |
| vapidPublicKey | Gets or sets VAPID public key. | genruntime.SecretReference Required |
GcmCredentialProperties
Description of a NotificationHub GcmCredential.
Used by: GcmCredential.
| Property | Description | Type |
|---|---|---|
| gcmEndpoint | Gets or sets the GCM endpoint. | genruntime.SecretReference Optional |
| googleApiKey | Gets or sets the Google API key. | genruntime.SecretReference Required |
IpRule
A network authorization rule that filters traffic based on IP address.
Used by: NetworkAcls.
| Property | Description | Type |
|---|---|---|
| ipMask | IP mask. | string Required |
| rights | List of access rights. | AccessRights[] Required |
IpRule_STATUS
A network authorization rule that filters traffic based on IP address.
Used by: NetworkAcls_STATUS.
| Property | Description | Type |
|---|---|---|
| ipMask | IP mask. | string Optional |
| rights | List of access rights. | AccessRights_STATUS[] Optional |
MpnsCredentialProperties
Description of a NotificationHub MpnsCredential.
Used by: MpnsCredential.
| Property | Description | Type |
|---|---|---|
| certificateKey | Gets or sets the certificate key for this credential. | genruntime.SecretReference Required |
| mpnsCertificate | Gets or sets the MPNS certificate. | genruntime.SecretReference Required |
| thumbprint | Gets or sets the MPNS certificate Thumbprint | genruntime.SecretReference Required |
PublicInternetAuthorizationRule
A default (public Internet) network authorization rule, which contains rights if no other network rule matches.
Used by: NetworkAcls.
| Property | Description | Type |
|---|---|---|
| rights | List of access rights. | AccessRights[] Required |
PublicInternetAuthorizationRule_STATUS
A default (public Internet) network authorization rule, which contains rights if no other network rule matches.
Used by: NetworkAcls_STATUS.
| Property | Description | Type |
|---|---|---|
| rights | List of access rights. | AccessRights_STATUS[] Optional |
WnsCredentialProperties
Description of a NotificationHub WnsCredential.
Used by: WnsCredential.
| Property | Description | Type |
|---|---|---|
| certificateKey | Ges or sets the WNS Certificate Key. | genruntime.SecretReference Optional |
| packageSid | Gets or sets the package ID for this credential. | genruntime.SecretReference Optional |
| secretKey | Gets or sets the secret key. | genruntime.SecretReference Optional |
| windowsLiveEndpoint | Gets or sets the Windows Live endpoint. | genruntime.SecretReference Optional |
| wnsCertificate | Gets or sets the WNS Certificate. | genruntime.SecretReference Optional |
XiaomiCredentialProperties
Description of a NotificationHub XiaomiCredentialProperties.
Used by: XiaomiCredential.
| Property | Description | Type |
|---|---|---|
| appSecret | Gets or sets app secret. | genruntime.SecretReference Optional |
| endpoint | Gets or sets xiaomi service endpoint. | genruntime.SecretReference Optional |