Documentation ¶
Overview ¶
Package redhatopenshift implements the Azure ARM Redhatopenshift service API version 2019-12-31-preview.
Rest API for Azure Red Hat OpenShift
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type BaseClient
- type CloudError
- type CloudErrorBody
- type Display
- type MasterProfile
- type NetworkProfile
- type OpenShiftCluster
- type OpenShiftClusterCredentials
- type OpenShiftClusterList
- type OpenShiftClustersClient
- func (client OpenShiftClustersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, ...) (result OpenShiftClustersCreateOrUpdateFuture, err error)
- func (client OpenShiftClustersClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, ...) (*http.Request, error)
- func (client OpenShiftClustersClient) CreateOrUpdateResponder(resp *http.Response) (result OpenShiftCluster, err error)
- func (client OpenShiftClustersClient) CreateOrUpdateSender(req *http.Request) (future OpenShiftClustersCreateOrUpdateFuture, err error)
- func (client OpenShiftClustersClient) Delete(ctx context.Context, resourceGroupName string, resourceName string) (result OpenShiftClustersDeleteFuture, err error)
- func (client OpenShiftClustersClient) DeletePreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
- func (client OpenShiftClustersClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client OpenShiftClustersClient) DeleteSender(req *http.Request) (future OpenShiftClustersDeleteFuture, err error)
- func (client OpenShiftClustersClient) Get(ctx context.Context, resourceGroupName string, resourceName string) (result OpenShiftCluster, err error)
- func (client OpenShiftClustersClient) GetCredentials(ctx context.Context, resourceGroupName string, resourceName string) (result OpenShiftClusterCredentials, err error)
- func (client OpenShiftClustersClient) GetCredentialsPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
- func (client OpenShiftClustersClient) GetCredentialsResponder(resp *http.Response) (result OpenShiftClusterCredentials, err error)
- func (client OpenShiftClustersClient) GetCredentialsSender(req *http.Request) (*http.Response, error)
- func (client OpenShiftClustersClient) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
- func (client OpenShiftClustersClient) GetResponder(resp *http.Response) (result OpenShiftCluster, err error)
- func (client OpenShiftClustersClient) GetSender(req *http.Request) (*http.Response, error)
- func (client OpenShiftClustersClient) List(ctx context.Context) (result OpenShiftClusterList, err error)
- func (client OpenShiftClustersClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result OpenShiftClusterList, err error)
- func (client OpenShiftClustersClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
- func (client OpenShiftClustersClient) ListByResourceGroupResponder(resp *http.Response) (result OpenShiftClusterList, err error)
- func (client OpenShiftClustersClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client OpenShiftClustersClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OpenShiftClustersClient) ListResponder(resp *http.Response) (result OpenShiftClusterList, err error)
- func (client OpenShiftClustersClient) ListSender(req *http.Request) (*http.Response, error)
- func (client OpenShiftClustersClient) Update(ctx context.Context, resourceGroupName string, resourceName string, ...) (result OpenShiftClustersUpdateFuture, err error)
- func (client OpenShiftClustersClient) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, ...) (*http.Request, error)
- func (client OpenShiftClustersClient) UpdateResponder(resp *http.Response) (result OpenShiftCluster, err error)
- func (client OpenShiftClustersClient) UpdateSender(req *http.Request) (future OpenShiftClustersUpdateFuture, err error)
- type OpenShiftClustersCreateOrUpdateFuture
- type OpenShiftClustersDeleteFuture
- type OpenShiftClustersUpdateFuture
- type Operation
- type OperationList
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result OperationList, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result OperationList, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
- type Properties
- type ProvisioningState
- type ServicePrincipalProfile
- type VMSize
- type VMSize1
- type WorkerProfile
Constants ¶
const (
// DefaultBaseURI is the default URI used for the service Redhatopenshift
DefaultBaseURI = "https://management.azure.com"
)
Variables ¶
This section is empty.
Functions ¶
func UserAgent ¶
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version ¶
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
Types ¶
type BaseClient ¶
BaseClient is the base client for Redhatopenshift.
func New ¶
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client.
type CloudError ¶
type CloudError struct { // Error - An error response from the service. Error *CloudErrorBody `json:"error,omitempty"` }
CloudError cloudError represents a cloud error.
type CloudErrorBody ¶
type CloudErrorBody struct { // Code - An identifier for the error. Codes are invariant and are intended to be consumed programmatically. Code *string `json:"code,omitempty"` // Message - A message describing the error, intended to be suitable for display in a user interface. Message *string `json:"message,omitempty"` // Target - The target of the particular error. For example, the name of the property in error. Target *string `json:"target,omitempty"` // Details - A list of additional details about the error. Details *[]CloudErrorBody `json:"details,omitempty"` }
CloudErrorBody cloudErrorBody represents the body of a cloud error.
type Display ¶
type Display struct { // Provider - Friendly name of the resource provider. Provider *string `json:"provider,omitempty"` // Resource - Resource type on which the operation is performed. Resource *string `json:"resource,omitempty"` // Operation - Operation type: read, write, delete, listKeys/action, etc. Operation *string `json:"operation,omitempty"` // Description - Friendly name of the operation. Description *string `json:"description,omitempty"` }
Display display represents the display details of an operation.
type MasterProfile ¶
type MasterProfile struct { // VMSize - The size of the master VMs (immutable). Possible values include: 'StandardD2sV3', 'StandardD4sV3', 'StandardD8sV3' VMSize VMSize `json:"vmSize,omitempty"` // SubnetID - The Azure resource ID of the worker subnet (immutable). SubnetID *string `json:"subnetId,omitempty"` }
MasterProfile masterProfile represents a master profile.
type NetworkProfile ¶
type NetworkProfile struct { // PodCidr - The CIDR used for OpenShift/Kubernetes Pods (immutable). PodCidr *string `json:"podCidr,omitempty"` // ServiceCidr - The CIDR used for OpenShift/Kubernetes Services (immutable). ServiceCidr *string `json:"serviceCidr,omitempty"` }
NetworkProfile networkProfile represents a network profile.
type OpenShiftCluster ¶
type OpenShiftCluster struct { autorest.Response `json:"-"` // ID - READ-ONLY; The resource ID (immutable). ID *string `json:"id,omitempty"` // Name - READ-ONLY; The resource name (immutable). Name *string `json:"name,omitempty"` // Type - READ-ONLY; The resource type (immutable). Type *string `json:"type,omitempty"` // Location - The resource location (immutable). Location *string `json:"location,omitempty"` // Tags - The resource tags. Tags map[string]*string `json:"tags"` // Properties - The cluster properties. *Properties `json:"properties,omitempty"` }
OpenShiftCluster openShiftCluster represents an Azure Red Hat OpenShift cluster.
func (OpenShiftCluster) MarshalJSON ¶
func (osc OpenShiftCluster) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OpenShiftCluster.
func (*OpenShiftCluster) UnmarshalJSON ¶
func (osc *OpenShiftCluster) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for OpenShiftCluster struct.
type OpenShiftClusterCredentials ¶
type OpenShiftClusterCredentials struct { autorest.Response `json:"-"` // KubeadminPassword - The password for the kubeadmin user KubeadminPassword *string `json:"kubeadminPassword,omitempty"` }
OpenShiftClusterCredentials openShiftClusterCredentials represents an OpenShift cluster's credentials
type OpenShiftClusterList ¶
type OpenShiftClusterList struct { autorest.Response `json:"-"` // Value - The list of OpenShift clusters. Value *[]OpenShiftCluster `json:"value,omitempty"` }
OpenShiftClusterList openShiftClusterList represents a list of OpenShift clusters.
type OpenShiftClustersClient ¶
type OpenShiftClustersClient struct {
BaseClient
}
OpenShiftClustersClient is the rest API for Azure Red Hat OpenShift
func NewOpenShiftClustersClient ¶
func NewOpenShiftClustersClient(subscriptionID string) OpenShiftClustersClient
NewOpenShiftClustersClient creates an instance of the OpenShiftClustersClient client.
func NewOpenShiftClustersClientWithBaseURI ¶
func NewOpenShiftClustersClientWithBaseURI(baseURI string, subscriptionID string) OpenShiftClustersClient
NewOpenShiftClustersClientWithBaseURI creates an instance of the OpenShiftClustersClient client.
func (OpenShiftClustersClient) CreateOrUpdate ¶
func (client OpenShiftClustersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, parameters OpenShiftCluster) (result OpenShiftClustersCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster. Parameters: resourceGroupName - the name of the resource group. resourceName - the name of the OpenShift cluster resource. parameters - the OpenShift cluster resource.
func (OpenShiftClustersClient) CreateOrUpdatePreparer ¶
func (client OpenShiftClustersClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, parameters OpenShiftCluster) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (OpenShiftClustersClient) CreateOrUpdateResponder ¶
func (client OpenShiftClustersClient) CreateOrUpdateResponder(resp *http.Response) (result OpenShiftCluster, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (OpenShiftClustersClient) CreateOrUpdateSender ¶
func (client OpenShiftClustersClient) CreateOrUpdateSender(req *http.Request) (future OpenShiftClustersCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (OpenShiftClustersClient) Delete ¶
func (client OpenShiftClustersClient) Delete(ctx context.Context, resourceGroupName string, resourceName string) (result OpenShiftClustersDeleteFuture, err error)
Delete deletes a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns nothing. Parameters: resourceGroupName - the name of the resource group. resourceName - the name of the OpenShift cluster resource.
func (OpenShiftClustersClient) DeletePreparer ¶
func (client OpenShiftClustersClient) DeletePreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (OpenShiftClustersClient) DeleteResponder ¶
func (client OpenShiftClustersClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (OpenShiftClustersClient) DeleteSender ¶
func (client OpenShiftClustersClient) DeleteSender(req *http.Request) (future OpenShiftClustersDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (OpenShiftClustersClient) Get ¶
func (client OpenShiftClustersClient) Get(ctx context.Context, resourceGroupName string, resourceName string) (result OpenShiftCluster, err error)
Get gets a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster. Parameters: resourceGroupName - the name of the resource group. resourceName - the name of the OpenShift cluster resource.
func (OpenShiftClustersClient) GetCredentials ¶
func (client OpenShiftClustersClient) GetCredentials(ctx context.Context, resourceGroupName string, resourceName string) (result OpenShiftClusterCredentials, err error)
GetCredentials gets credentials of a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns the credentials. Parameters: resourceGroupName - the name of the resource group. resourceName - the name of the OpenShift cluster resource.
func (OpenShiftClustersClient) GetCredentialsPreparer ¶
func (client OpenShiftClustersClient) GetCredentialsPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
GetCredentialsPreparer prepares the GetCredentials request.
func (OpenShiftClustersClient) GetCredentialsResponder ¶
func (client OpenShiftClustersClient) GetCredentialsResponder(resp *http.Response) (result OpenShiftClusterCredentials, err error)
GetCredentialsResponder handles the response to the GetCredentials request. The method always closes the http.Response Body.
func (OpenShiftClustersClient) GetCredentialsSender ¶
func (client OpenShiftClustersClient) GetCredentialsSender(req *http.Request) (*http.Response, error)
GetCredentialsSender sends the GetCredentials request. The method will close the http.Response Body if it receives an error.
func (OpenShiftClustersClient) GetPreparer ¶
func (client OpenShiftClustersClient) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (OpenShiftClustersClient) GetResponder ¶
func (client OpenShiftClustersClient) GetResponder(resp *http.Response) (result OpenShiftCluster, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (OpenShiftClustersClient) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (OpenShiftClustersClient) List ¶
func (client OpenShiftClustersClient) List(ctx context.Context) (result OpenShiftClusterList, err error)
List lists OpenShift clusters in the specified subscription. The operation returns properties of each OpenShift cluster.
func (OpenShiftClustersClient) ListByResourceGroup ¶
func (client OpenShiftClustersClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result OpenShiftClusterList, err error)
ListByResourceGroup lists OpenShift clusters in the specified subscription and resource group. The operation returns properties of each OpenShift cluster. Parameters: resourceGroupName - the name of the resource group.
func (OpenShiftClustersClient) ListByResourceGroupPreparer ¶
func (client OpenShiftClustersClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (OpenShiftClustersClient) ListByResourceGroupResponder ¶
func (client OpenShiftClustersClient) ListByResourceGroupResponder(resp *http.Response) (result OpenShiftClusterList, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (OpenShiftClustersClient) ListByResourceGroupSender ¶
func (client OpenShiftClustersClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (OpenShiftClustersClient) ListPreparer ¶
ListPreparer prepares the List request.
func (OpenShiftClustersClient) ListResponder ¶
func (client OpenShiftClustersClient) ListResponder(resp *http.Response) (result OpenShiftClusterList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (OpenShiftClustersClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (OpenShiftClustersClient) Update ¶
func (client OpenShiftClustersClient) Update(ctx context.Context, resourceGroupName string, resourceName string, parameters OpenShiftCluster) (result OpenShiftClustersUpdateFuture, err error)
Update creates or updates a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster. Parameters: resourceGroupName - the name of the resource group. resourceName - the name of the OpenShift cluster resource. parameters - the OpenShift cluster resource.
func (OpenShiftClustersClient) UpdatePreparer ¶
func (client OpenShiftClustersClient) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, parameters OpenShiftCluster) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (OpenShiftClustersClient) UpdateResponder ¶
func (client OpenShiftClustersClient) UpdateResponder(resp *http.Response) (result OpenShiftCluster, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (OpenShiftClustersClient) UpdateSender ¶
func (client OpenShiftClustersClient) UpdateSender(req *http.Request) (future OpenShiftClustersUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type OpenShiftClustersCreateOrUpdateFuture ¶
OpenShiftClustersCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*OpenShiftClustersCreateOrUpdateFuture) Result ¶
func (future *OpenShiftClustersCreateOrUpdateFuture) Result(client OpenShiftClustersClient) (osc OpenShiftCluster, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
type OpenShiftClustersDeleteFuture ¶
OpenShiftClustersDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*OpenShiftClustersDeleteFuture) Result ¶
func (future *OpenShiftClustersDeleteFuture) Result(client OpenShiftClustersClient) (ar autorest.Response, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
type OpenShiftClustersUpdateFuture ¶
OpenShiftClustersUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*OpenShiftClustersUpdateFuture) Result ¶
func (future *OpenShiftClustersUpdateFuture) Result(client OpenShiftClustersClient) (osc OpenShiftCluster, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
type Operation ¶
type Operation struct { // Name - Operation name: {provider}/{resource}/{operation}. Name *string `json:"name,omitempty"` // Display - The object that describes the operation. Display *Display `json:"display,omitempty"` }
Operation operation represents an operation.
type OperationList ¶
type OperationList struct { autorest.Response `json:"-"` // Value - List of operations supported by the resource provider. Value *[]Operation `json:"value,omitempty"` }
OperationList operationList represents an operation list.
type OperationsClient ¶
type OperationsClient struct {
BaseClient
}
OperationsClient is the rest API for Azure Red Hat OpenShift
func NewOperationsClient ¶
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI ¶
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.
func (OperationsClient) List ¶
func (client OperationsClient) List(ctx context.Context) (result OperationList, err error)
List lists all of the available RP operations. The operation returns the operations.
func (OperationsClient) ListPreparer ¶
ListPreparer prepares the List request.
func (OperationsClient) ListResponder ¶
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (OperationsClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type Properties ¶
type Properties struct { // ProvisioningState - The cluster provisioning state (immutable). Possible values include: 'Creating', 'Deleting', 'Failed', 'Succeeded', 'Updating' ProvisioningState ProvisioningState `json:"provisioningState,omitempty"` // ServicePrincipalProfile - The cluster service principal profile. ServicePrincipalProfile *ServicePrincipalProfile `json:"servicePrincipalProfile,omitempty"` // NetworkProfile - The cluster network profile. NetworkProfile *NetworkProfile `json:"networkProfile,omitempty"` // MasterProfile - The cluster master profile. MasterProfile *MasterProfile `json:"masterProfile,omitempty"` // WorkerProfiles - The cluster worker profiles. WorkerProfiles *[]WorkerProfile `json:"workerProfiles,omitempty"` // ApiserverURL - The URL to access the cluster API server (immutable). ApiserverURL *string `json:"apiserverUrl,omitempty"` // ConsoleURL - The URL to access the cluster console (immutable). ConsoleURL *string `json:"consoleUrl,omitempty"` }
Properties properties represents an OpenShift cluster's properties.
type ProvisioningState ¶
type ProvisioningState string
ProvisioningState enumerates the values for provisioning state.
const ( // Creating ... Creating ProvisioningState = "Creating" // Deleting ... Deleting ProvisioningState = "Deleting" // Failed ... Failed ProvisioningState = "Failed" // Succeeded ... Succeeded ProvisioningState = "Succeeded" // Updating ... Updating ProvisioningState = "Updating" )
func PossibleProvisioningStateValues ¶
func PossibleProvisioningStateValues() []ProvisioningState
PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.
type ServicePrincipalProfile ¶
type ServicePrincipalProfile struct { // ClientID - The client ID used for the cluster ClientID *string `json:"clientId,omitempty"` // ClientSecret - The client secret used for the cluster ClientSecret *string `json:"clientSecret,omitempty"` }
ServicePrincipalProfile servicePrincipalProfile represents a service principal profile.
type VMSize ¶
type VMSize string
VMSize enumerates the values for vm size.
func PossibleVMSizeValues ¶
func PossibleVMSizeValues() []VMSize
PossibleVMSizeValues returns an array of possible values for the VMSize const type.
type VMSize1 ¶
type VMSize1 string
VMSize1 enumerates the values for vm size 1.
func PossibleVMSize1Values ¶
func PossibleVMSize1Values() []VMSize1
PossibleVMSize1Values returns an array of possible values for the VMSize1 const type.
type WorkerProfile ¶
type WorkerProfile struct { // Name - The worker profile name. Must be "worker" (immutable). Name *string `json:"name,omitempty"` // VMSize - The size of the worker VMs (immutable). Possible values include: 'VMSize1StandardD2sV3', 'VMSize1StandardD4sV3', 'VMSize1StandardD8sV3' VMSize VMSize1 `json:"vmSize,omitempty"` // DiskSizeGB - The disk size of the worker VMs. Must be 128 or greater (immutable). DiskSizeGB *int32 `json:"diskSizeGB,omitempty"` // SubnetID - The Azure resource ID of the worker subnet (immutable). SubnetID *string `json:"subnetId,omitempty"` // Count - The number of worker VMs. Must be between 3 and 20. Count *int32 `json:"count,omitempty"` }
WorkerProfile workerProfile represents a worker profile.