Microsoft.Azure.PowerShell.Cmdlets.RedHatOpenShiftHcp.Models Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
| Name | Description |
|---|---|
| Any |
Anything |
| ApiProfile |
Information about the API of a cluster. |
| ApiProfileUpdate |
Information about the API of a cluster. |
| AzureResourceManagerCommonTypesManagedServiceIdentityUpdate |
Managed service identity (system assigned and/or user assigned identities) |
| AzureResourceManagerCommonTypesManagedServiceIdentityUpdateUserAssignedIdentities |
The identities assigned to this resource by the user. |
| AzureResourceManagerCommonTypesTrackedResourceUpdate |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' |
| AzureResourceManagerCommonTypesTrackedResourceUpdateTags |
Resource tags. |
| ClusterActiveVersion |
ClusterActiveVersion represents a version of a resource. |
| ClusterAutoscalingProfile |
ClusterAutoscaling specifies auto-scaling behavior that applies to all NodePools associated with a control plane. |
| ClusterImageRegistryProfile |
OpenShift cluster image registry |
| ClusterResourceStatus |
ClusterResourceStatus represents the observed status of the cluster resource. |
| Condition |
Condition represents an observation of a resource's state. |
| ConsoleProfile |
Configuration of the cluster web console |
| ContainerRegistryProfile |
Azure Container Registry configuration for a cluster. Configures how worker nodes authenticate container image pulls from Azure Container Registry (ACR). |
| CustomerManagedEncryptionProfile |
Customer managed encryption key profile. |
| CustomerManagedEncryptionProfileUpdate |
Customer managed encryption key profile. |
| DnsProfile |
DNS contains the DNS settings of the cluster |
| ErrorAdditionalInfo |
The resource management error additional info. |
| ErrorDetail |
The error detail. |
| ErrorResponse |
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). |
| EtcdDataEncryptionProfile |
The ETCD data encryption settings. |
| EtcdDataEncryptionProfileUpdate |
The ETCD data encryption settings. |
| EtcdProfile |
The ETCD settings and configuration options. |
| EtcdProfileUpdate |
The ETCD settings and configuration options. |
| ExternalAuth |
ExternalAuth resource |
| ExternalAuthClaimProfile |
External Auth claim profile |
| ExternalAuthClaimProfileUpdate |
External Auth claim profile |
| ExternalAuthClientComponentProfile |
External Auth component profile Must have unique namespace/name pairs. |
| ExternalAuthClientProfile |
External Auth client profile This configures how on-cluster, platform clients should request tokens from the identity provider. |
| ExternalAuthListResult |
The response of a ExternalAuth list operation. |
| ExternalAuthProperties |
External Auth profile |
| ExternalAuthPropertiesUpdate |
External Auth profile |
| ExternalAuthResourceStatus |
ExternalAuthResourceStatus represents the observed status of the external auth resource. |
| ExternalAuthUpdate |
ExternalAuth resource |
| GroupClaimProfile |
External Auth claim profile This configures how the groups of a cluster identity should be constructed from the claims in a JWT token issued by the identity provider. When referencing a claim, if the claim is present in the JWT token, its value must be a list of groups separated by a comma (','). For example - '"example"' and '"exampleOne", "exampleTwo", "exampleThree"' are valid claim values. |
| GroupClaimProfileUpdate |
External Auth claim profile This configures how the groups of a cluster identity should be constructed from the claims in a JWT token issued by the identity provider. When referencing a claim, if the claim is present in the JWT token, its value must be a list of groups separated by a comma (','). For example - '"example"' and '"exampleOne", "exampleTwo", "exampleThree"' are valid claim values. |
| HcpOpenShiftCluster |
HCP cluster resource |
| HcpOpenShiftClusterAdminCredential |
HCP cluster admin credential |
| HcpOpenShiftClusterAdminCredentialRequest |
HCP cluster admin credential request body |
| HcpOpenShiftClusterListResult |
The response of a HcpOpenShiftCluster list operation. |
| HcpOpenShiftClusterProperties |
HCP cluster properties |
| HcpOpenShiftClusterPropertiesUpdate |
HCP cluster properties |
| HcpOpenShiftClusterUpdate |
HCP cluster resource |
| HcpOpenShiftVersion |
HcpOpenShiftVersion represents a location based available HCP OpenShift version |
| HcpOpenShiftVersionListResult |
The response of a HcpOpenShiftVersion list operation. |
| HcpOpenShiftVersionProperties |
HcpOpenShiftVersionProperties contains details of an available HCP Openshift version |
| HcpOperatorIdentityRoleSet |
HcpOperatorIdentityRoles represents a location based representation of the required platform workload identities and their required roles for a given OpenShift version |
| HcpOperatorIdentityRoleSetListResult |
The response of a HcpOperatorIdentityRoleSet list operation. |
| HcpOperatorIdentityRoleSetProperties |
HCP Operator Identity Roles properties |
| ImageDigestMirror |
ImageDigestMirror specifies a set of mirror registries to redirect image pulls targeting the specified source registries. |
| IngressProfile |
Information about the Ingress of a cluster. |
| KmsEncryptionProfile |
Configure etcd encryption Key Management Service (KMS) key.
Your Microsoft Entra application used to create the cluster must be authorized to access this keyvault,
e.g using the AzureCLI: |
| KmsEncryptionProfileUpdate |
Configure etcd encryption Key Management Service (KMS) key.
Your Microsoft Entra application used to create the cluster must be authorized to access this keyvault,
e.g using the AzureCLI: |
| KmsKey |
A representation of a KeyVault Secret. |
| KmsKeyUpdate |
A representation of a KeyVault Secret. |
| Label |
Label represents the Kubernetes label |
| ManagedServiceIdentity |
Managed service identity (system assigned and/or user assigned identities) |
| ManagedServiceIdentityUserAssignedIdentities |
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. |
| NetworkProfile |
OpenShift networking configuration |
| NodePool |
Concrete tracked resource types can be created by aliasing this type using a specific property type. |
| NodePoolActiveVersion |
NodePoolActiveVersion represents a version of a resource. |
| NodePoolAutoScaling |
Node pool autoscaling |
| NodePoolListResult |
The response of a NodePool list operation. |
| NodePoolPlatformProfile |
Azure node pool platform configuration |
| NodePoolProperties |
Represents the node pool properties |
| NodePoolPropertiesUpdate |
Represents the node pool properties |
| NodePoolResourceStatus |
NodePoolResourceStatus represents the observed status of the nodepool resource. |
| NodePoolUpdate |
Concrete tracked resource types can be created by aliasing this type using a specific property type. |
| NodePoolVersionProfile |
Versions represents an OpenShift version. |
| NodePoolVersionProfileUpdate |
Versions represents an OpenShift version. |
| Operation |
Details of a REST API operation, returned from the Resource Provider Operations API |
| OperationDisplay |
Localized display information for this particular operation. |
| OperationListResult |
A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. |
| OperatorIdentityRoles |
Role definitions for a specific operator |
| OperatorsAuthenticationProfile |
The configuration that the operators of the cluster have to authenticate to Azure. |
| OperatorsAuthenticationProfileUpdate |
The configuration that the operators of the cluster have to authenticate to Azure. |
| OSDiskProfile |
The settings and configuration options for OSDisk |
| PlatformProfile |
Azure specific configuration |
| PlatformProfileUpdate |
Azure specific configuration |
| ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
| RedHatOpenShiftHcpIdentity | |
| Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
| RoleDefinition |
A single role definition required by a given operator |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
| Taint |
Taint is controlling the node taint and its effects |
| TokenClaimMappingsProfile |
External Auth claim mappings profile. At a minimum username or groups must be defined. |
| TokenClaimMappingsProfileUpdate |
External Auth claim mappings profile. At a minimum username or groups must be defined. |
| TokenClaimValidationRule |
External Auth claim validation rule |
| TokenIssuerProfile |
Token issuer profile This configures how the platform interacts with the identity provider and how tokens issued from the identity provider are evaluated by the Kubernetes API server. |
| TokenIssuerProfileUpdate |
Token issuer profile This configures how the platform interacts with the identity provider and how tokens issued from the identity provider are evaluated by the Kubernetes API server. |
| TokenRequiredClaim |
Token required claim validation rule. |
| TrackedResource |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' |
| TrackedResourceTags |
Resource tags. |
| UserAssignedIdentitiesProfile |
Represents the information related to Azure User-Assigned managed identities needed to perform Operators authentication based on Azure User-Assigned Managed Identities |
| UserAssignedIdentitiesProfileControlPlaneOperators |
The set of Azure User-Assigned Managed Identities leveraged for the Control Plane operators of the cluster. The set of required managed identities is dependent on the Cluster's OpenShift version. |
| UserAssignedIdentitiesProfileDataPlaneOperators |
The set of Azure User-Assigned Managed Identities leveraged for the Data Plane operators of the cluster. The set of required managed identities is dependent on the Cluster's OpenShift version. |
| UserAssignedIdentitiesProfileUpdate |
Represents the information related to Azure User-Assigned managed identities needed to perform Operators authentication based on Azure User-Assigned Managed Identities |
| UserAssignedIdentitiesProfileUpdateControlPlaneOperators |
The set of Azure User-Assigned Managed Identities leveraged for the Control Plane operators of the cluster. The set of required managed identities is dependent on the Cluster's OpenShift version. |
| UserAssignedIdentitiesProfileUpdateDataPlaneOperators |
The set of Azure User-Assigned Managed Identities leveraged for the Data Plane operators of the cluster. The set of required managed identities is dependent on the Cluster's OpenShift version. |
| UserAssignedIdentity |
User assigned identity properties |
| UsernameClaimProfile |
External Auth claim profile This configures how the username of a cluster identity should be constructed from the claims in a JWT token issued by the identity provider. |
| UsernameClaimProfileUpdate |
External Auth claim profile This configures how the username of a cluster identity should be constructed from the claims in a JWT token issued by the identity provider. |
| VersionProfile |
Versions represents an OpenShift version. |
| VersionProfileUpdate |
Versions represents an OpenShift version. |