communication.azure.com/v20230401
APIVersion
| Value | Description |
|---|---|
| “2023-04-01” |
CommunicationService
Generator information: - Generated from: /communication/resource-manager/Microsoft.Communication/stable/2023-04-01/CommunicationServices.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}
Used by: CommunicationServiceList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | CommunicationService_Spec Optional |
|
| status | CommunicationService_STATUS Optional |
CommunicationService_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 |
| dataLocation | The location where the communication service stores its data at rest. | string Required |
| identity | Managed service identity (system assigned and/or user assigned identities) | ManagedServiceIdentity Optional |
| linkedDomainsReferences | genruntime.ResourceReference[] 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 | CommunicationServiceOperatorSpec 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 |
| tags | Resource tags. | map[string]string Optional |
CommunicationService_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| dataLocation | The location where the communication service stores its data at rest. | string Optional |
| hostName | FQDN of the CommunicationService instance. | string Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| identity | Managed service identity (system assigned and/or user assigned identities) | ManagedServiceIdentity_STATUS Optional |
| immutableResourceId | The immutable resource Id of the communication service. | string Optional |
| linkedDomains | string[] Optional |
|
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| notificationHubId | Resource ID of an Azure Notification Hub linked to this resource. | string Optional |
| provisioningState | Provisioning state of the resource. | CommunicationServiceProperties_ProvisioningState_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 |
| version | Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs. | string Optional |
CommunicationServiceList
Generator information: - Generated from: /communication/resource-manager/Microsoft.Communication/stable/2023-04-01/CommunicationServices.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | CommunicationService[] Optional |
Domain
Generator information: - Generated from: /communication/resource-manager/Microsoft.Communication/stable/2023-04-01/Domains.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}
Used by: DomainList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Domain_Spec Optional |
|
| status | Domain_STATUS Optional |
Domain_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 |
| domainManagement | Describes how a Domains resource is being managed. | DomainManagement Required |
| 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 | DomainOperatorSpec 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 communication.azure.com/EmailService resource | genruntime.KnownResourceReference Required |
| tags | Resource tags. | map[string]string Optional |
| userEngagementTracking | Describes whether user engagement tracking is enabled or disabled. | UserEngagementTracking Optional |
Domain_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| dataLocation | The location where the Domains resource data is stored at rest. | string Optional |
| domainManagement | Describes how a Domains resource is being managed. | DomainManagement_STATUS Optional |
| fromSenderDomain | P2 sender domain that is displayed to the email recipients [RFC 5322]. | string 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 |
| mailFromSenderDomain | P1 sender domain that is present on the email envelope [RFC 5321]. | string Optional |
| name | The name of the resource | string Optional |
| provisioningState | Provisioning state of the resource. | DomainProperties_ProvisioningState_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 |
| userEngagementTracking | Describes whether user engagement tracking is enabled or disabled. | UserEngagementTracking_STATUS Optional |
| verificationRecords | List of DnsRecord | DomainProperties_VerificationRecords_STATUS Optional |
| verificationStates | List of VerificationStatusRecord | DomainProperties_VerificationStates_STATUS Optional |
DomainList
Generator information: - Generated from: /communication/resource-manager/Microsoft.Communication/stable/2023-04-01/Domains.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Domain[] Optional |
EmailService
Generator information: - Generated from: /communication/resource-manager/Microsoft.Communication/stable/2023-04-01/EmailServices.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}
Used by: EmailServiceList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | EmailService_Spec Optional |
|
| status | EmailService_STATUS Optional |
EmailService_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 |
| dataLocation | The location where the email service stores its data at rest. | string Required |
| 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 | EmailServiceOperatorSpec 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 |
| tags | Resource tags. | map[string]string Optional |
EmailService_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| dataLocation | The location where the email service stores its data at rest. | string 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 |
| provisioningState | Provisioning state of the resource. | EmailServiceProperties_ProvisioningState_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 |
EmailServiceList
Generator information: - Generated from: /communication/resource-manager/Microsoft.Communication/stable/2023-04-01/EmailServices.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | EmailService[] Optional |
SenderUsername
Generator information: - Generated from: /communication/resource-manager/Microsoft.Communication/stable/2023-04-01/SenderUsernames.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/senderUsernames/{senderUsername}
Used by: SenderUsernameList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | SenderUsername_Spec Optional |
|
| status | SenderUsername_STATUS Optional |
SenderUsername_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 |
| displayName | The display name for the senderUsername. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | SenderUsernameOperatorSpec 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 communication.azure.com/Domain resource | genruntime.KnownResourceReference Required |
| username | A sender senderUsername to be used when sending emails. | string Required |
SenderUsername_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| dataLocation | The location where the SenderUsername resource data is stored at rest. | string Optional |
| displayName | The display name for the senderUsername. | string Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| name | The name of the resource | string Optional |
| provisioningState | Provisioning state of the resource. Unknown is the default state for Communication Services. | SenderUsernameProperties_ProvisioningState_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| username | A sender senderUsername to be used when sending emails. | string Optional |
SenderUsernameList
Generator information: - Generated from: /communication/resource-manager/Microsoft.Communication/stable/2023-04-01/SenderUsernames.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/senderUsernames/{senderUsername}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | SenderUsername[] Optional |
CommunicationService_Spec
Used by: CommunicationService.
| 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 |
| dataLocation | The location where the communication service stores its data at rest. | string Required |
| identity | Managed service identity (system assigned and/or user assigned identities) | ManagedServiceIdentity Optional |
| linkedDomainsReferences | genruntime.ResourceReference[] 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 | CommunicationServiceOperatorSpec 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 |
| tags | Resource tags. | map[string]string Optional |
CommunicationService_STATUS
Used by: CommunicationService.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| dataLocation | The location where the communication service stores its data at rest. | string Optional |
| hostName | FQDN of the CommunicationService instance. | string Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| identity | Managed service identity (system assigned and/or user assigned identities) | ManagedServiceIdentity_STATUS Optional |
| immutableResourceId | The immutable resource Id of the communication service. | string Optional |
| linkedDomains | string[] Optional |
|
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| notificationHubId | Resource ID of an Azure Notification Hub linked to this resource. | string Optional |
| provisioningState | Provisioning state of the resource. | CommunicationServiceProperties_ProvisioningState_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 |
| version | Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs. | string Optional |
Domain_Spec
Used by: Domain.
| 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 |
| domainManagement | Describes how a Domains resource is being managed. | DomainManagement Required |
| 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 | DomainOperatorSpec 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 communication.azure.com/EmailService resource | genruntime.KnownResourceReference Required |
| tags | Resource tags. | map[string]string Optional |
| userEngagementTracking | Describes whether user engagement tracking is enabled or disabled. | UserEngagementTracking Optional |
Domain_STATUS
Used by: Domain.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| dataLocation | The location where the Domains resource data is stored at rest. | string Optional |
| domainManagement | Describes how a Domains resource is being managed. | DomainManagement_STATUS Optional |
| fromSenderDomain | P2 sender domain that is displayed to the email recipients [RFC 5322]. | string 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 |
| mailFromSenderDomain | P1 sender domain that is present on the email envelope [RFC 5321]. | string Optional |
| name | The name of the resource | string Optional |
| provisioningState | Provisioning state of the resource. | DomainProperties_ProvisioningState_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 |
| userEngagementTracking | Describes whether user engagement tracking is enabled or disabled. | UserEngagementTracking_STATUS Optional |
| verificationRecords | List of DnsRecord | DomainProperties_VerificationRecords_STATUS Optional |
| verificationStates | List of VerificationStatusRecord | DomainProperties_VerificationStates_STATUS Optional |
EmailService_Spec
Used by: EmailService.
| 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 |
| dataLocation | The location where the email service stores its data at rest. | string Required |
| 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 | EmailServiceOperatorSpec 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 |
| tags | Resource tags. | map[string]string Optional |
EmailService_STATUS
Used by: EmailService.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| dataLocation | The location where the email service stores its data at rest. | string 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 |
| provisioningState | Provisioning state of the resource. | EmailServiceProperties_ProvisioningState_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 |
SenderUsername_Spec
Used by: SenderUsername.
| 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 |
| displayName | The display name for the senderUsername. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | SenderUsernameOperatorSpec 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 communication.azure.com/Domain resource | genruntime.KnownResourceReference Required |
| username | A sender senderUsername to be used when sending emails. | string Required |
SenderUsername_STATUS
Used by: SenderUsername.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| dataLocation | The location where the SenderUsername resource data is stored at rest. | string Optional |
| displayName | The display name for the senderUsername. | string Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| name | The name of the resource | string Optional |
| provisioningState | Provisioning state of the resource. Unknown is the default state for Communication Services. | SenderUsernameProperties_ProvisioningState_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| username | A sender senderUsername to be used when sending emails. | string Optional |
CommunicationServiceOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: CommunicationService_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. | CommunicationServiceOperatorConfigMaps 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. | CommunicationServiceOperatorSecrets Optional |
CommunicationServiceProperties_ProvisioningState_STATUS
Used by: CommunicationService_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Moving” | |
| “Running” | |
| “Succeeded” | |
| “Unknown” | |
| “Updating” |
DomainManagement
Describes how a Domains resource is being managed.
Used by: Domain_Spec.
| Value | Description |
|---|---|
| “AzureManaged” | |
| “CustomerManaged” | |
| “CustomerManagedInExchangeOnline” |
DomainManagement_STATUS
Describes how a Domains resource is being managed.
Used by: Domain_STATUS.
| Value | Description |
|---|---|
| “AzureManaged” | |
| “CustomerManaged” | |
| “CustomerManagedInExchangeOnline” |
DomainOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Domain_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 |
DomainProperties_ProvisioningState_STATUS
Used by: Domain_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Moving” | |
| “Running” | |
| “Succeeded” | |
| “Unknown” | |
| “Updating” |
DomainProperties_VerificationRecords_STATUS
Used by: Domain_STATUS.
| Property | Description | Type |
|---|---|---|
| DKIM | A class that represents a VerificationStatus record. | DnsRecord_STATUS Optional |
| DKIM2 | A class that represents a VerificationStatus record. | DnsRecord_STATUS Optional |
| DMARC | A class that represents a VerificationStatus record. | DnsRecord_STATUS Optional |
| Domain | A class that represents a VerificationStatus record. | DnsRecord_STATUS Optional |
| SPF | A class that represents a VerificationStatus record. | DnsRecord_STATUS Optional |
DomainProperties_VerificationStates_STATUS
Used by: Domain_STATUS.
| Property | Description | Type |
|---|---|---|
| DKIM | A class that represents a VerificationStatus record. | VerificationStatusRecord_STATUS Optional |
| DKIM2 | A class that represents a VerificationStatus record. | VerificationStatusRecord_STATUS Optional |
| DMARC | A class that represents a VerificationStatus record. | VerificationStatusRecord_STATUS Optional |
| Domain | A class that represents a VerificationStatus record. | VerificationStatusRecord_STATUS Optional |
| SPF | A class that represents a VerificationStatus record. | VerificationStatusRecord_STATUS Optional |
EmailServiceOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: EmailService_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 |
EmailServiceProperties_ProvisioningState_STATUS
Used by: EmailService_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Moving” | |
| “Running” | |
| “Succeeded” | |
| “Unknown” | |
| “Updating” |
ManagedServiceIdentity
Managed service identity (system assigned and/or user assigned identities)
Used by: CommunicationService_Spec.
| Property | Description | Type |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | ManagedServiceIdentityType Required |
| userAssignedIdentities | UserAssignedIdentityDetails[] Optional |
ManagedServiceIdentity_STATUS
Managed service identity (system assigned and/or user assigned identities)
Used by: CommunicationService_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. | string Optional |
| tenantId | The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. | string Optional |
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | ManagedServiceIdentityType_STATUS Optional |
| userAssignedIdentities | map[string]UserAssignedIdentity_STATUS Optional |
SenderUsernameOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: SenderUsername_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 |
SenderUsernameProperties_ProvisioningState_STATUS
Used by: SenderUsername_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Moving” | |
| “Running” | |
| “Succeeded” | |
| “Unknown” | |
| “Updating” |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: CommunicationService_STATUS, Domain_STATUS, EmailService_STATUS, and SenderUsername_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 |
UserEngagementTracking
Describes whether user engagement tracking is enabled or disabled.
Used by: Domain_Spec.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
UserEngagementTracking_STATUS
Describes whether user engagement tracking is enabled or disabled.
Used by: Domain_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
CommunicationServiceOperatorConfigMaps
Used by: CommunicationServiceOperatorSpec.
| Property | Description | Type |
|---|---|---|
| hostName | indicates where the HostName config map should be placed. If omitted, no config map will be created. | genruntime.ConfigMapDestination Optional |
CommunicationServiceOperatorSecrets
Used by: CommunicationServiceOperatorSpec.
| 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 |
DnsRecord_STATUS
A class that represents a VerificationStatus record.
Used by: DomainProperties_VerificationRecords_STATUS, DomainProperties_VerificationRecords_STATUS, DomainProperties_VerificationRecords_STATUS, DomainProperties_VerificationRecords_STATUS, and DomainProperties_VerificationRecords_STATUS.
| Property | Description | Type |
|---|---|---|
| name | Name of the DNS record. | string Optional |
| ttl | Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. | int Optional |
| type | Type of the DNS record. Example: TXT | string Optional |
| value | Value of the DNS record. | string Optional |
ManagedServiceIdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Used by: ManagedServiceIdentity.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned,UserAssigned” | |
| “UserAssigned” |
ManagedServiceIdentityType_STATUS
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Used by: ManagedServiceIdentity_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned,UserAssigned” | |
| “UserAssigned” |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
UserAssignedIdentity_STATUS
User assigned identity properties
Used by: ManagedServiceIdentity_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | The client ID of the assigned identity. | string Optional |
| principalId | The principal ID of the assigned identity. | string Optional |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: ManagedServiceIdentity.
| Property | Description | Type |
|---|---|---|
| reference | genruntime.ResourceReference Optional |
VerificationStatusRecord_STATUS
A class that represents a VerificationStatus record.
Used by: DomainProperties_VerificationStates_STATUS, DomainProperties_VerificationStates_STATUS, DomainProperties_VerificationStates_STATUS, DomainProperties_VerificationStates_STATUS, and DomainProperties_VerificationStates_STATUS.
| Property | Description | Type |
|---|---|---|
| errorCode | Error code. This property will only be present if the status is UnableToVerify. | string Optional |
| status | Status of the verification operation. | VerificationStatusRecord_Status_STATUS Optional |
VerificationStatusRecord_Status_STATUS
Used by: VerificationStatusRecord_STATUS.
| Value | Description |
|---|---|
| “CancellationRequested” | |
| “NotStarted” | |
| “VerificationFailed” | |
| “VerificationInProgress” | |
| “VerificationRequested” | |
| “Verified” |