redhatopenshift.azure.com/v1api20231122

redhatopenshift.azure.com/v1api20231122

Package v1api20231122 contains API Schema definitions for the redhatopenshift v1api20231122 API group

Resource Types:

    APIServerProfile

    (Appears on:OpenShiftCluster_Spec)

    APIServerProfile represents an API server profile.

    Field Description
    visibility
    Visibility

    Visibility: API server visibility.

    APIServerProfile_ARM

    (Appears on:OpenShiftClusterProperties_ARM)

    APIServerProfile represents an API server profile.

    Field Description
    visibility
    Visibility

    Visibility: API server visibility.

    APIServerProfile_STATUS

    (Appears on:OpenShiftCluster_STATUS)

    APIServerProfile represents an API server profile.

    Field Description
    ip
    string

    Ip: The IP of the cluster API server.
    url
    string

    Url: The URL to access the cluster API server.
    visibility
    Visibility_STATUS

    Visibility: API server visibility.

    APIServerProfile_STATUS_ARM

    (Appears on:OpenShiftClusterProperties_STATUS_ARM)

    APIServerProfile represents an API server profile.

    Field Description
    ip
    string

    Ip: The IP of the cluster API server.
    url
    string

    Url: The URL to access the cluster API server.
    visibility
    Visibility_STATUS

    Visibility: API server visibility.

    APIVersion (string alias)

    Value Description

    "2023-11-22"

    ClusterProfile

    (Appears on:OpenShiftCluster_Spec)

    ClusterProfile represents a cluster profile.

    Field Description
    domain
    string

    Domain: The domain for the cluster.
    fipsValidatedModules
    FipsValidatedModules

    FipsValidatedModules: If FIPS validated crypto modules are used
    pullSecret
    genruntime.SecretReference

    PullSecret: The pull secret for the cluster.
    resourceGroupId
    string

    ResourceGroupId: The ID of the cluster resource group.
    version
    string

    Version: The version of the cluster.

    ClusterProfile_ARM

    (Appears on:OpenShiftClusterProperties_ARM)

    ClusterProfile represents a cluster profile.

    Field Description
    domain
    string

    Domain: The domain for the cluster.
    fipsValidatedModules
    FipsValidatedModules

    FipsValidatedModules: If FIPS validated crypto modules are used
    pullSecret
    string

    PullSecret: The pull secret for the cluster.
    resourceGroupId
    string

    ResourceGroupId: The ID of the cluster resource group.
    version
    string

    Version: The version of the cluster.

    ClusterProfile_STATUS

    (Appears on:OpenShiftCluster_STATUS)

    ClusterProfile represents a cluster profile.

    Field Description
    domain
    string

    Domain: The domain for the cluster.
    fipsValidatedModules
    FipsValidatedModules_STATUS

    FipsValidatedModules: If FIPS validated crypto modules are used
    resourceGroupId
    string

    ResourceGroupId: The ID of the cluster resource group.
    version
    string

    Version: The version of the cluster.

    ClusterProfile_STATUS_ARM

    (Appears on:OpenShiftClusterProperties_STATUS_ARM)

    ClusterProfile represents a cluster profile.

    Field Description
    domain
    string

    Domain: The domain for the cluster.
    fipsValidatedModules
    FipsValidatedModules_STATUS

    FipsValidatedModules: If FIPS validated crypto modules are used
    resourceGroupId
    string

    ResourceGroupId: The ID of the cluster resource group.
    version
    string

    Version: The version of the cluster.

    ConsoleProfile_STATUS

    (Appears on:OpenShiftCluster_STATUS)

    ConsoleProfile represents a console profile.

    Field Description
    url
    string

    Url: The URL to access the cluster console.

    ConsoleProfile_STATUS_ARM

    (Appears on:OpenShiftClusterProperties_STATUS_ARM)

    ConsoleProfile represents a console profile.

    Field Description
    url
    string

    Url: The URL to access the cluster console.

    EffectiveOutboundIP_STATUS

    (Appears on:LoadBalancerProfile_STATUS)

    EffectiveOutboundIP represents an effective outbound IP resource of the cluster public load balancer.

    Field Description
    id
    string

    Id: The fully qualified Azure resource id of an IP address resource.

    EffectiveOutboundIP_STATUS_ARM

    (Appears on:LoadBalancerProfile_STATUS_ARM)

    EffectiveOutboundIP represents an effective outbound IP resource of the cluster public load balancer.

    Field Description
    id
    string

    Id: The fully qualified Azure resource id of an IP address resource.

    EncryptionAtHost (string alias)

    (Appears on:MasterProfile, MasterProfile_ARM, WorkerProfile, WorkerProfile_ARM)

    EncryptionAtHost represents encryption at host state

    Value Description

    "Disabled"

    "Enabled"

    EncryptionAtHost_STATUS (string alias)

    (Appears on:MasterProfile_STATUS, MasterProfile_STATUS_ARM, WorkerProfile_STATUS, WorkerProfile_STATUS_ARM)

    EncryptionAtHost represents encryption at host state

    Value Description

    "Disabled"

    "Enabled"

    FipsValidatedModules (string alias)

    (Appears on:ClusterProfile, ClusterProfile_ARM)

    FipsValidatedModules determines if FIPS is used.

    Value Description

    "Disabled"

    "Enabled"

    FipsValidatedModules_STATUS (string alias)

    (Appears on:ClusterProfile_STATUS, ClusterProfile_STATUS_ARM)

    FipsValidatedModules determines if FIPS is used.

    Value Description

    "Disabled"

    "Enabled"

    IngressProfile

    (Appears on:OpenShiftCluster_Spec)

    IngressProfile represents an ingress profile.

    Field Description
    name
    string

    Name: The ingress profile name.
    visibility
    Visibility

    Visibility: Ingress visibility.

    IngressProfile_ARM

    (Appears on:OpenShiftClusterProperties_ARM)

    IngressProfile represents an ingress profile.

    Field Description
    name
    string

    Name: The ingress profile name.
    visibility
    Visibility

    Visibility: Ingress visibility.

    IngressProfile_STATUS

    (Appears on:OpenShiftCluster_STATUS)

    IngressProfile represents an ingress profile.

    Field Description
    ip
    string

    Ip: The IP of the ingress.
    name
    string

    Name: The ingress profile name.
    visibility
    Visibility_STATUS

    Visibility: Ingress visibility.

    IngressProfile_STATUS_ARM

    (Appears on:OpenShiftClusterProperties_STATUS_ARM)

    IngressProfile represents an ingress profile.

    Field Description
    ip
    string

    Ip: The IP of the ingress.
    name
    string

    Name: The ingress profile name.
    visibility
    Visibility_STATUS

    Visibility: Ingress visibility.

    LoadBalancerProfile

    (Appears on:NetworkProfile)

    LoadBalancerProfile represents the profile of the cluster public load balancer.

    Field Description
    managedOutboundIps
    ManagedOutboundIPs

    ManagedOutboundIps: The desired managed outbound IPs for the cluster public load balancer.

    LoadBalancerProfile_ARM

    (Appears on:NetworkProfile_ARM)

    LoadBalancerProfile represents the profile of the cluster public load balancer.

    Field Description
    managedOutboundIps
    ManagedOutboundIPs_ARM

    ManagedOutboundIps: The desired managed outbound IPs for the cluster public load balancer.

    LoadBalancerProfile_STATUS

    (Appears on:NetworkProfile_STATUS)

    LoadBalancerProfile represents the profile of the cluster public load balancer.

    Field Description
    effectiveOutboundIps
    []EffectiveOutboundIP_STATUS

    EffectiveOutboundIps: The list of effective outbound IP addresses of the public load balancer.
    managedOutboundIps
    ManagedOutboundIPs_STATUS

    ManagedOutboundIps: The desired managed outbound IPs for the cluster public load balancer.

    LoadBalancerProfile_STATUS_ARM

    (Appears on:NetworkProfile_STATUS_ARM)

    LoadBalancerProfile represents the profile of the cluster public load balancer.

    Field Description
    effectiveOutboundIps
    []EffectiveOutboundIP_STATUS_ARM

    EffectiveOutboundIps: The list of effective outbound IP addresses of the public load balancer.
    managedOutboundIps
    ManagedOutboundIPs_STATUS_ARM

    ManagedOutboundIps: The desired managed outbound IPs for the cluster public load balancer.

    ManagedOutboundIPs

    (Appears on:LoadBalancerProfile)

    ManagedOutboundIPs represents the desired managed outbound IPs for the cluster public load balancer.

    Field Description
    count
    int

    Count: Count represents the desired number of IPv4 outbound IPs created and managed by Azure for the cluster public load balancer. Allowed values are in the range of 1 - 20. The default value is 1.

    ManagedOutboundIPs_ARM

    (Appears on:LoadBalancerProfile_ARM)

    ManagedOutboundIPs represents the desired managed outbound IPs for the cluster public load balancer.

    Field Description
    count
    int

    Count: Count represents the desired number of IPv4 outbound IPs created and managed by Azure for the cluster public load balancer. Allowed values are in the range of 1 - 20. The default value is 1.

    ManagedOutboundIPs_STATUS

    (Appears on:LoadBalancerProfile_STATUS)

    ManagedOutboundIPs represents the desired managed outbound IPs for the cluster public load balancer.

    Field Description
    count
    int

    Count: Count represents the desired number of IPv4 outbound IPs created and managed by Azure for the cluster public load balancer. Allowed values are in the range of 1 - 20. The default value is 1.

    ManagedOutboundIPs_STATUS_ARM

    (Appears on:LoadBalancerProfile_STATUS_ARM)

    ManagedOutboundIPs represents the desired managed outbound IPs for the cluster public load balancer.

    Field Description
    count
    int

    Count: Count represents the desired number of IPv4 outbound IPs created and managed by Azure for the cluster public load balancer. Allowed values are in the range of 1 - 20. The default value is 1.

    MasterProfile

    (Appears on:OpenShiftCluster_Spec)

    MasterProfile represents a master profile.

    Field Description
    diskEncryptionSetReference
    genruntime.ResourceReference

    DiskEncryptionSetReference: The resource ID of an associated DiskEncryptionSet, if applicable.
    encryptionAtHost
    EncryptionAtHost

    EncryptionAtHost: Whether master virtual machines are encrypted at host.
    subnetReference
    genruntime.ResourceReference

    SubnetReference: The Azure resource ID of the master subnet.
    vmSize
    string

    VmSize: The size of the master VMs.

    MasterProfile_ARM

    (Appears on:OpenShiftClusterProperties_ARM)

    MasterProfile represents a master profile.

    Field Description
    diskEncryptionSetId
    string
    encryptionAtHost
    EncryptionAtHost

    EncryptionAtHost: Whether master virtual machines are encrypted at host.
    subnetId
    string
    vmSize
    string

    VmSize: The size of the master VMs.

    MasterProfile_STATUS

    (Appears on:OpenShiftCluster_STATUS)

    MasterProfile represents a master profile.

    Field Description
    diskEncryptionSetId
    string

    DiskEncryptionSetId: The resource ID of an associated DiskEncryptionSet, if applicable.
    encryptionAtHost
    EncryptionAtHost_STATUS

    EncryptionAtHost: Whether master virtual machines are encrypted at host.
    subnetId
    string

    SubnetId: The Azure resource ID of the master subnet.
    vmSize
    string

    VmSize: The size of the master VMs.

    MasterProfile_STATUS_ARM

    (Appears on:OpenShiftClusterProperties_STATUS_ARM)

    MasterProfile represents a master profile.

    Field Description
    diskEncryptionSetId
    string

    DiskEncryptionSetId: The resource ID of an associated DiskEncryptionSet, if applicable.
    encryptionAtHost
    EncryptionAtHost_STATUS

    EncryptionAtHost: Whether master virtual machines are encrypted at host.
    subnetId
    string

    SubnetId: The Azure resource ID of the master subnet.
    vmSize
    string

    VmSize: The size of the master VMs.

    NetworkProfile

    (Appears on:OpenShiftCluster_Spec)

    NetworkProfile represents a network profile.

    Field Description
    loadBalancerProfile
    LoadBalancerProfile

    LoadBalancerProfile: The cluster load balancer profile.
    outboundType
    OutboundType

    OutboundType: The OutboundType used for egress traffic.
    podCidr
    string

    PodCidr: The CIDR used for OpenShift/Kubernetes Pods.
    preconfiguredNSG
    PreconfiguredNSG

    PreconfiguredNSG: Specifies whether subnets are pre-attached with an NSG
    serviceCidr
    string

    ServiceCidr: The CIDR used for OpenShift/Kubernetes Services.

    NetworkProfile_ARM

    (Appears on:OpenShiftClusterProperties_ARM)

    NetworkProfile represents a network profile.

    Field Description
    loadBalancerProfile
    LoadBalancerProfile_ARM

    LoadBalancerProfile: The cluster load balancer profile.
    outboundType
    OutboundType

    OutboundType: The OutboundType used for egress traffic.
    podCidr
    string

    PodCidr: The CIDR used for OpenShift/Kubernetes Pods.
    preconfiguredNSG
    PreconfiguredNSG

    PreconfiguredNSG: Specifies whether subnets are pre-attached with an NSG
    serviceCidr
    string

    ServiceCidr: The CIDR used for OpenShift/Kubernetes Services.

    NetworkProfile_STATUS

    (Appears on:OpenShiftCluster_STATUS)

    NetworkProfile represents a network profile.

    Field Description
    loadBalancerProfile
    LoadBalancerProfile_STATUS

    LoadBalancerProfile: The cluster load balancer profile.
    outboundType
    OutboundType_STATUS

    OutboundType: The OutboundType used for egress traffic.
    podCidr
    string

    PodCidr: The CIDR used for OpenShift/Kubernetes Pods.
    preconfiguredNSG
    PreconfiguredNSG_STATUS

    PreconfiguredNSG: Specifies whether subnets are pre-attached with an NSG
    serviceCidr
    string

    ServiceCidr: The CIDR used for OpenShift/Kubernetes Services.

    NetworkProfile_STATUS_ARM

    (Appears on:OpenShiftClusterProperties_STATUS_ARM)

    NetworkProfile represents a network profile.

    Field Description
    loadBalancerProfile
    LoadBalancerProfile_STATUS_ARM

    LoadBalancerProfile: The cluster load balancer profile.
    outboundType
    OutboundType_STATUS

    OutboundType: The OutboundType used for egress traffic.
    podCidr
    string

    PodCidr: The CIDR used for OpenShift/Kubernetes Pods.
    preconfiguredNSG
    PreconfiguredNSG_STATUS

    PreconfiguredNSG: Specifies whether subnets are pre-attached with an NSG
    serviceCidr
    string

    ServiceCidr: The CIDR used for OpenShift/Kubernetes Services.

    OpenShiftCluster

    Generator information: - Generated from: /redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/stable/2023-11-22/redhatopenshift.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.RedHatOpenShift/​openShiftClusters/​{resourceName}

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

    apiserverProfile
    APIServerProfile

    ApiserverProfile: The cluster API server profile.
    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
    clusterProfile
    ClusterProfile

    ClusterProfile: The cluster profile.
    ingressProfiles
    []IngressProfile

    IngressProfiles: The cluster ingress profiles.
    location
    string

    Location: The geo-location where the resource lives
    masterProfile
    MasterProfile

    MasterProfile: The cluster master profile.
    networkProfile
    NetworkProfile

    NetworkProfile: The cluster network profile.
    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
    servicePrincipalProfile
    ServicePrincipalProfile

    ServicePrincipalProfile: The cluster service principal profile.
    tags
    map[string]string

    Tags: Resource tags.
    workerProfiles
    []WorkerProfile

    WorkerProfiles: The cluster worker profiles.
    status
    OpenShiftCluster_STATUS

    OpenShiftClusterProperties_ARM

    (Appears on:OpenShiftCluster_Spec_ARM)

    OpenShiftClusterProperties represents an OpenShift cluster’s properties.

    Field Description
    apiserverProfile
    APIServerProfile_ARM

    ApiserverProfile: The cluster API server profile.
    clusterProfile
    ClusterProfile_ARM

    ClusterProfile: The cluster profile.
    ingressProfiles
    []IngressProfile_ARM

    IngressProfiles: The cluster ingress profiles.
    masterProfile
    MasterProfile_ARM

    MasterProfile: The cluster master profile.
    networkProfile
    NetworkProfile_ARM

    NetworkProfile: The cluster network profile.
    servicePrincipalProfile
    ServicePrincipalProfile_ARM

    ServicePrincipalProfile: The cluster service principal profile.
    workerProfiles
    []WorkerProfile_ARM

    WorkerProfiles: The cluster worker profiles.

    OpenShiftClusterProperties_STATUS_ARM

    (Appears on:OpenShiftCluster_STATUS_ARM)

    OpenShiftClusterProperties represents an OpenShift cluster’s properties.

    Field Description
    apiserverProfile
    APIServerProfile_STATUS_ARM

    ApiserverProfile: The cluster API server profile.
    clusterProfile
    ClusterProfile_STATUS_ARM

    ClusterProfile: The cluster profile.
    consoleProfile
    ConsoleProfile_STATUS_ARM

    ConsoleProfile: The console profile.
    ingressProfiles
    []IngressProfile_STATUS_ARM

    IngressProfiles: The cluster ingress profiles.
    masterProfile
    MasterProfile_STATUS_ARM

    MasterProfile: The cluster master profile.
    networkProfile
    NetworkProfile_STATUS_ARM

    NetworkProfile: The cluster network profile.
    provisioningState
    ProvisioningState_STATUS

    ProvisioningState: The cluster provisioning state.
    servicePrincipalProfile
    ServicePrincipalProfile_STATUS_ARM

    ServicePrincipalProfile: The cluster service principal profile.
    workerProfiles
    []WorkerProfile_STATUS_ARM

    WorkerProfiles: The cluster worker profiles.
    workerProfilesStatus
    []WorkerProfile_STATUS_ARM

    WorkerProfilesStatus: The cluster worker profiles status.

    OpenShiftCluster_STATUS

    (Appears on:OpenShiftCluster)

    OpenShiftCluster represents an Azure Red Hat OpenShift cluster.

    Field Description
    apiserverProfile
    APIServerProfile_STATUS

    ApiserverProfile: The cluster API server profile.
    clusterProfile
    ClusterProfile_STATUS

    ClusterProfile: The cluster profile.
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource
    consoleProfile
    ConsoleProfile_STATUS

    ConsoleProfile: The console profile.
    id
    string

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

    ingressProfiles
    []IngressProfile_STATUS

    IngressProfiles: The cluster ingress profiles.
    location
    string

    Location: The geo-location where the resource lives
    masterProfile
    MasterProfile_STATUS

    MasterProfile: The cluster master profile.
    name
    string

    Name: The name of the resource
    networkProfile
    NetworkProfile_STATUS

    NetworkProfile: The cluster network profile.
    provisioningState
    ProvisioningState_STATUS

    ProvisioningState: The cluster provisioning state.
    servicePrincipalProfile
    ServicePrincipalProfile_STATUS

    ServicePrincipalProfile: The cluster service principal profile.
    systemData
    SystemData_STATUS

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

    Tags: Resource tags.
    type
    string

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

    WorkerProfiles: The cluster worker profiles.
    workerProfilesStatus
    []WorkerProfile_STATUS

    WorkerProfilesStatus: The cluster worker profiles status.

    OpenShiftCluster_STATUS_ARM

    OpenShiftCluster represents an Azure Red Hat OpenShift cluster.

    Field Description
    id
    string

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

    location
    string

    Location: The geo-location where the resource lives
    name
    string

    Name: The name of the resource
    properties
    OpenShiftClusterProperties_STATUS_ARM

    Properties: The cluster properties.
    systemData
    SystemData_STATUS_ARM

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

    Tags: Resource tags.
    type
    string

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

    OpenShiftCluster_Spec

    (Appears on:OpenShiftCluster)

    Field Description
    apiserverProfile
    APIServerProfile

    ApiserverProfile: The cluster API server profile.
    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
    clusterProfile
    ClusterProfile

    ClusterProfile: The cluster profile.
    ingressProfiles
    []IngressProfile

    IngressProfiles: The cluster ingress profiles.
    location
    string

    Location: The geo-location where the resource lives
    masterProfile
    MasterProfile

    MasterProfile: The cluster master profile.
    networkProfile
    NetworkProfile

    NetworkProfile: The cluster network profile.
    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
    servicePrincipalProfile
    ServicePrincipalProfile

    ServicePrincipalProfile: The cluster service principal profile.
    tags
    map[string]string

    Tags: Resource tags.
    workerProfiles
    []WorkerProfile

    WorkerProfiles: The cluster worker profiles.

    OpenShiftCluster_Spec_ARM

    Field Description
    location
    string

    Location: The geo-location where the resource lives
    name
    string
    properties
    OpenShiftClusterProperties_ARM

    Properties: The cluster properties.
    tags
    map[string]string

    Tags: Resource tags.

    OutboundType (string alias)

    (Appears on:NetworkProfile, NetworkProfile_ARM)

    The outbound routing strategy used to provide your cluster egress to the internet.

    Value Description

    "Loadbalancer"

    "UserDefinedRouting"

    OutboundType_STATUS (string alias)

    (Appears on:NetworkProfile_STATUS, NetworkProfile_STATUS_ARM)

    The outbound routing strategy used to provide your cluster egress to the internet.

    Value Description

    "Loadbalancer"

    "UserDefinedRouting"

    PreconfiguredNSG (string alias)

    (Appears on:NetworkProfile, NetworkProfile_ARM)

    PreconfiguredNSG represents whether customers want to use their own NSG attached to the subnets

    Value Description

    "Disabled"

    "Enabled"

    PreconfiguredNSG_STATUS (string alias)

    (Appears on:NetworkProfile_STATUS, NetworkProfile_STATUS_ARM)

    PreconfiguredNSG represents whether customers want to use their own NSG attached to the subnets

    Value Description

    "Disabled"

    "Enabled"

    ProvisioningState_STATUS (string alias)

    (Appears on:OpenShiftClusterProperties_STATUS_ARM, OpenShiftCluster_STATUS)

    ProvisioningState represents a provisioning state.

    Value Description

    "AdminUpdating"

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    ServicePrincipalProfile

    (Appears on:OpenShiftCluster_Spec)

    ServicePrincipalProfile represents a service principal profile.

    Field Description
    clientId
    string

    ClientId: The client ID used for the cluster.
    clientIdFromConfig
    genruntime.ConfigMapReference

    ClientIdFromConfig: The client ID used for the cluster.
    clientSecret
    genruntime.SecretReference

    ClientSecret: The client secret used for the cluster.

    ServicePrincipalProfile_ARM

    (Appears on:OpenShiftClusterProperties_ARM)

    ServicePrincipalProfile represents a service principal profile.

    Field Description
    clientId
    string

    ClientId: The client ID used for the cluster.
    clientSecret
    string

    ClientSecret: The client secret used for the cluster.

    ServicePrincipalProfile_STATUS

    (Appears on:OpenShiftCluster_STATUS)

    ServicePrincipalProfile represents a service principal profile.

    Field Description
    clientId
    string

    ClientId: The client ID used for the cluster.

    ServicePrincipalProfile_STATUS_ARM

    (Appears on:OpenShiftClusterProperties_STATUS_ARM)

    ServicePrincipalProfile represents a service principal profile.

    Field Description
    clientId
    string

    ClientId: The client ID used for the cluster.

    SystemData_CreatedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS, SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS, SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_STATUS

    (Appears on:OpenShiftCluster_STATUS)

    Metadata pertaining to creation and last modification of the resource.

    Field Description
    createdAt
    string

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

    CreatedBy: The identity that created the resource.
    createdByType
    SystemData_CreatedByType_STATUS

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

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

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

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

    SystemData_STATUS_ARM

    (Appears on:OpenShiftCluster_STATUS_ARM)

    Metadata pertaining to creation and last modification of the resource.

    Field Description
    createdAt
    string

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

    CreatedBy: The identity that created the resource.
    createdByType
    SystemData_CreatedByType_STATUS

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

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

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

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

    Visibility (string alias)

    (Appears on:APIServerProfile, APIServerProfile_ARM, IngressProfile, IngressProfile_ARM)

    Visibility represents visibility.

    Value Description

    "Private"

    "Public"

    Visibility_STATUS (string alias)

    (Appears on:APIServerProfile_STATUS, APIServerProfile_STATUS_ARM, IngressProfile_STATUS, IngressProfile_STATUS_ARM)

    Visibility represents visibility.

    Value Description

    "Private"

    "Public"

    WorkerProfile

    (Appears on:OpenShiftCluster_Spec)

    WorkerProfile represents a worker profile.

    Field Description
    count
    int

    Count: The number of worker VMs.
    diskEncryptionSetReference
    genruntime.ResourceReference

    DiskEncryptionSetReference: The resource ID of an associated DiskEncryptionSet, if applicable.
    diskSizeGB
    int

    DiskSizeGB: The disk size of the worker VMs.
    encryptionAtHost
    EncryptionAtHost

    EncryptionAtHost: Whether master virtual machines are encrypted at host.
    name
    string

    Name: The worker profile name.
    subnetReference
    genruntime.ResourceReference

    SubnetReference: The Azure resource ID of the worker subnet.
    vmSize
    string

    VmSize: The size of the worker VMs.

    WorkerProfile_ARM

    (Appears on:OpenShiftClusterProperties_ARM)

    WorkerProfile represents a worker profile.

    Field Description
    count
    int

    Count: The number of worker VMs.
    diskEncryptionSetId
    string
    diskSizeGB
    int

    DiskSizeGB: The disk size of the worker VMs.
    encryptionAtHost
    EncryptionAtHost

    EncryptionAtHost: Whether master virtual machines are encrypted at host.
    name
    string

    Name: The worker profile name.
    subnetId
    string
    vmSize
    string

    VmSize: The size of the worker VMs.

    WorkerProfile_STATUS

    (Appears on:OpenShiftCluster_STATUS)

    WorkerProfile represents a worker profile.

    Field Description
    count
    int

    Count: The number of worker VMs.
    diskEncryptionSetId
    string

    DiskEncryptionSetId: The resource ID of an associated DiskEncryptionSet, if applicable.
    diskSizeGB
    int

    DiskSizeGB: The disk size of the worker VMs.
    encryptionAtHost
    EncryptionAtHost_STATUS

    EncryptionAtHost: Whether master virtual machines are encrypted at host.
    name
    string

    Name: The worker profile name.
    subnetId
    string

    SubnetId: The Azure resource ID of the worker subnet.
    vmSize
    string

    VmSize: The size of the worker VMs.

    WorkerProfile_STATUS_ARM

    (Appears on:OpenShiftClusterProperties_STATUS_ARM)

    WorkerProfile represents a worker profile.

    Field Description
    count
    int

    Count: The number of worker VMs.
    diskEncryptionSetId
    string

    DiskEncryptionSetId: The resource ID of an associated DiskEncryptionSet, if applicable.
    diskSizeGB
    int

    DiskSizeGB: The disk size of the worker VMs.
    encryptionAtHost
    EncryptionAtHost_STATUS

    EncryptionAtHost: Whether master virtual machines are encrypted at host.
    name
    string

    Name: The worker profile name.
    subnetId
    string

    SubnetId: The Azure resource ID of the worker subnet.
    vmSize
    string

    VmSize: The size of the worker VMs.