Documentation ¶
Overview ¶
Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/redhatopenshift/armredhatopenshift(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/redhatopenshift/armredhatopenshift). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.
Package redhatopenshift implements the Azure ARM Redhatopenshift service API version 2022-04-01.
Rest API for Azure Red Hat OpenShift 4
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type APIServerProfile
- type AzureEntityResource
- type BaseClient
- type CloudError
- type CloudErrorBody
- type ClusterProfile
- type ConsoleProfile
- type CreatedByType
- type Display
- type EncryptionAtHost
- type FipsValidatedModules
- type IngressProfile
- type MasterProfile
- type NetworkProfile
- type OpenShiftCluster
- type OpenShiftClusterAdminKubeconfig
- type OpenShiftClusterCredentials
- type OpenShiftClusterList
- type OpenShiftClusterListIterator
- func (iter *OpenShiftClusterListIterator) Next() error
- func (iter *OpenShiftClusterListIterator) NextWithContext(ctx context.Context) (err error)
- func (iter OpenShiftClusterListIterator) NotDone() bool
- func (iter OpenShiftClusterListIterator) Response() OpenShiftClusterList
- func (iter OpenShiftClusterListIterator) Value() OpenShiftCluster
- type OpenShiftClusterListPage
- func (page *OpenShiftClusterListPage) Next() error
- func (page *OpenShiftClusterListPage) NextWithContext(ctx context.Context) (err error)
- func (page OpenShiftClusterListPage) NotDone() bool
- func (page OpenShiftClusterListPage) Response() OpenShiftClusterList
- func (page OpenShiftClusterListPage) Values() []OpenShiftCluster
- type OpenShiftClusterProperties
- type OpenShiftClusterUpdate
- 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) 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 OpenShiftClusterListPage, err error)
- func (client OpenShiftClustersClient) ListAdminCredentials(ctx context.Context, resourceGroupName string, resourceName string) (result OpenShiftClusterAdminKubeconfig, err error)
- func (client OpenShiftClustersClient) ListAdminCredentialsPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
- func (client OpenShiftClustersClient) ListAdminCredentialsResponder(resp *http.Response) (result OpenShiftClusterAdminKubeconfig, err error)
- func (client OpenShiftClustersClient) ListAdminCredentialsSender(req *http.Request) (*http.Response, error)
- func (client OpenShiftClustersClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result OpenShiftClusterListPage, err error)
- func (client OpenShiftClustersClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result OpenShiftClusterListIterator, 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) ListComplete(ctx context.Context) (result OpenShiftClusterListIterator, err error)
- func (client OpenShiftClustersClient) ListCredentials(ctx context.Context, resourceGroupName string, resourceName string) (result OpenShiftClusterCredentials, err error)
- func (client OpenShiftClustersClient) ListCredentialsPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
- func (client OpenShiftClustersClient) ListCredentialsResponder(resp *http.Response) (result OpenShiftClusterCredentials, err error)
- func (client OpenShiftClustersClient) ListCredentialsSender(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 OperationListIterator
- type OperationListPage
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result OperationListPage, err error)
- func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListIterator, 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 ProvisioningState
- type ProxyResource
- type Resource
- type ServicePrincipalProfile
- type SystemData
- type TrackedResource
- type Visibility
- 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 APIServerProfile ¶
type APIServerProfile struct { // Visibility - API server visibility. Possible values include: 'VisibilityPrivate', 'VisibilityPublic' Visibility Visibility `json:"visibility,omitempty"` // URL - The URL to access the cluster API server. URL *string `json:"url,omitempty"` // IP - The IP of the cluster API server. IP *string `json:"ip,omitempty"` }
APIServerProfile aPIServerProfile represents an API server profile.
type AzureEntityResource ¶
type AzureEntityResource struct { // Etag - READ-ONLY; Resource Etag. Etag *string `json:"etag,omitempty"` // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ID *string `json:"id,omitempty"` // Name - READ-ONLY; The name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" Type *string `json:"type,omitempty"` }
AzureEntityResource the resource model definition for an Azure Resource Manager resource with an etag.
func (AzureEntityResource) MarshalJSON ¶
func (aer AzureEntityResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AzureEntityResource.
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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
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 ClusterProfile ¶
type ClusterProfile struct { // PullSecret - The pull secret for the cluster. PullSecret *string `json:"pullSecret,omitempty"` // Domain - The domain for the cluster. Domain *string `json:"domain,omitempty"` // Version - The version of the cluster. Version *string `json:"version,omitempty"` // ResourceGroupID - The ID of the cluster resource group. ResourceGroupID *string `json:"resourceGroupId,omitempty"` // FipsValidatedModules - If FIPS validated crypto modules are used. Possible values include: 'FipsValidatedModulesDisabled', 'FipsValidatedModulesEnabled' FipsValidatedModules FipsValidatedModules `json:"fipsValidatedModules,omitempty"` }
ClusterProfile clusterProfile represents a cluster profile.
type ConsoleProfile ¶
type ConsoleProfile struct { // URL - The URL to access the cluster console. URL *string `json:"url,omitempty"` }
ConsoleProfile consoleProfile represents a console profile.
type CreatedByType ¶
type CreatedByType string
CreatedByType enumerates the values for created by type.
const ( // CreatedByTypeApplication ... CreatedByTypeApplication CreatedByType = "Application" // CreatedByTypeKey ... CreatedByTypeKey CreatedByType = "Key" // CreatedByTypeManagedIdentity ... CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity" // CreatedByTypeUser ... CreatedByTypeUser CreatedByType = "User" )
func PossibleCreatedByTypeValues ¶
func PossibleCreatedByTypeValues() []CreatedByType
PossibleCreatedByTypeValues returns an array of possible values for the CreatedByType const type.
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 EncryptionAtHost ¶
type EncryptionAtHost string
EncryptionAtHost enumerates the values for encryption at host.
const ( // EncryptionAtHostDisabled ... EncryptionAtHostDisabled EncryptionAtHost = "Disabled" // EncryptionAtHostEnabled ... EncryptionAtHostEnabled EncryptionAtHost = "Enabled" )
func PossibleEncryptionAtHostValues ¶
func PossibleEncryptionAtHostValues() []EncryptionAtHost
PossibleEncryptionAtHostValues returns an array of possible values for the EncryptionAtHost const type.
type FipsValidatedModules ¶
type FipsValidatedModules string
FipsValidatedModules enumerates the values for fips validated modules.
const ( // FipsValidatedModulesDisabled ... FipsValidatedModulesDisabled FipsValidatedModules = "Disabled" // FipsValidatedModulesEnabled ... FipsValidatedModulesEnabled FipsValidatedModules = "Enabled" )
func PossibleFipsValidatedModulesValues ¶
func PossibleFipsValidatedModulesValues() []FipsValidatedModules
PossibleFipsValidatedModulesValues returns an array of possible values for the FipsValidatedModules const type.
type IngressProfile ¶
type IngressProfile struct { // Name - The ingress profile name. Name *string `json:"name,omitempty"` // Visibility - Ingress visibility. Possible values include: 'VisibilityPrivate', 'VisibilityPublic' Visibility Visibility `json:"visibility,omitempty"` // IP - The IP of the ingress. IP *string `json:"ip,omitempty"` }
IngressProfile ingressProfile represents an ingress profile.
type MasterProfile ¶
type MasterProfile struct { // VMSize - The size of the master VMs. VMSize *string `json:"vmSize,omitempty"` // SubnetID - The Azure resource ID of the master subnet. SubnetID *string `json:"subnetId,omitempty"` // EncryptionAtHost - Whether master virtual machines are encrypted at host. Possible values include: 'EncryptionAtHostDisabled', 'EncryptionAtHostEnabled' EncryptionAtHost EncryptionAtHost `json:"encryptionAtHost,omitempty"` // DiskEncryptionSetID - The resource ID of an associated DiskEncryptionSet, if applicable. DiskEncryptionSetID *string `json:"diskEncryptionSetId,omitempty"` }
MasterProfile masterProfile represents a master profile.
type NetworkProfile ¶
type NetworkProfile struct { // PodCidr - The CIDR used for OpenShift/Kubernetes Pods. PodCidr *string `json:"podCidr,omitempty"` // ServiceCidr - The CIDR used for OpenShift/Kubernetes Services. ServiceCidr *string `json:"serviceCidr,omitempty"` }
NetworkProfile networkProfile represents a network profile.
type OpenShiftCluster ¶
type OpenShiftCluster struct { autorest.Response `json:"-"` // OpenShiftClusterProperties - The cluster properties. *OpenShiftClusterProperties `json:"properties,omitempty"` // SystemData - READ-ONLY; The system meta data relating to this resource. SystemData *SystemData `json:"systemData,omitempty"` // Tags - Resource tags. Tags map[string]*string `json:"tags"` // Location - The geo-location where the resource lives Location *string `json:"location,omitempty"` // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ID *string `json:"id,omitempty"` // Name - READ-ONLY; The name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" Type *string `json:"type,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 OpenShiftClusterAdminKubeconfig ¶
type OpenShiftClusterAdminKubeconfig struct { autorest.Response `json:"-"` // Kubeconfig - The base64-encoded kubeconfig file. Kubeconfig *string `json:"kubeconfig,omitempty"` }
OpenShiftClusterAdminKubeconfig openShiftClusterAdminKubeconfig represents an OpenShift cluster's admin kubeconfig.
type OpenShiftClusterCredentials ¶
type OpenShiftClusterCredentials struct { autorest.Response `json:"-"` // KubeadminUsername - The username for the kubeadmin user. KubeadminUsername *string `json:"kubeadminUsername,omitempty"` // 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"` // NextLink - The link used to get the next page of operations. NextLink *string `json:"nextLink,omitempty"` }
OpenShiftClusterList openShiftClusterList represents a list of OpenShift clusters.
func (OpenShiftClusterList) IsEmpty ¶
func (oscl OpenShiftClusterList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type OpenShiftClusterListIterator ¶
type OpenShiftClusterListIterator struct {
// contains filtered or unexported fields
}
OpenShiftClusterListIterator provides access to a complete listing of OpenShiftCluster values.
func NewOpenShiftClusterListIterator ¶
func NewOpenShiftClusterListIterator(page OpenShiftClusterListPage) OpenShiftClusterListIterator
Creates a new instance of the OpenShiftClusterListIterator type.
func (*OpenShiftClusterListIterator) Next ¶
func (iter *OpenShiftClusterListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*OpenShiftClusterListIterator) NextWithContext ¶
func (iter *OpenShiftClusterListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (OpenShiftClusterListIterator) NotDone ¶
func (iter OpenShiftClusterListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (OpenShiftClusterListIterator) Response ¶
func (iter OpenShiftClusterListIterator) Response() OpenShiftClusterList
Response returns the raw server response from the last page request.
func (OpenShiftClusterListIterator) Value ¶
func (iter OpenShiftClusterListIterator) Value() OpenShiftCluster
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type OpenShiftClusterListPage ¶
type OpenShiftClusterListPage struct {
// contains filtered or unexported fields
}
OpenShiftClusterListPage contains a page of OpenShiftCluster values.
func NewOpenShiftClusterListPage ¶
func NewOpenShiftClusterListPage(cur OpenShiftClusterList, getNextPage func(context.Context, OpenShiftClusterList) (OpenShiftClusterList, error)) OpenShiftClusterListPage
Creates a new instance of the OpenShiftClusterListPage type.
func (*OpenShiftClusterListPage) Next ¶
func (page *OpenShiftClusterListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*OpenShiftClusterListPage) NextWithContext ¶
func (page *OpenShiftClusterListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (OpenShiftClusterListPage) NotDone ¶
func (page OpenShiftClusterListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (OpenShiftClusterListPage) Response ¶
func (page OpenShiftClusterListPage) Response() OpenShiftClusterList
Response returns the raw server response from the last page request.
func (OpenShiftClusterListPage) Values ¶
func (page OpenShiftClusterListPage) Values() []OpenShiftCluster
Values returns the slice of values for the current page or nil if there are no values.
type OpenShiftClusterProperties ¶
type OpenShiftClusterProperties struct { // ProvisioningState - The cluster provisioning state. Possible values include: 'ProvisioningStateAdminUpdating', 'ProvisioningStateCreating', 'ProvisioningStateDeleting', 'ProvisioningStateFailed', 'ProvisioningStateSucceeded', 'ProvisioningStateUpdating' ProvisioningState ProvisioningState `json:"provisioningState,omitempty"` // ClusterProfile - The cluster profile. ClusterProfile *ClusterProfile `json:"clusterProfile,omitempty"` // ConsoleProfile - The console profile. ConsoleProfile *ConsoleProfile `json:"consoleProfile,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"` // ApiserverProfile - The cluster API server profile. ApiserverProfile *APIServerProfile `json:"apiserverProfile,omitempty"` // IngressProfiles - The cluster ingress profiles. IngressProfiles *[]IngressProfile `json:"ingressProfiles,omitempty"` }
OpenShiftClusterProperties openShiftClusterProperties represents an OpenShift cluster's properties.
type OpenShiftClusterUpdate ¶
type OpenShiftClusterUpdate struct { // Tags - The resource tags. Tags map[string]*string `json:"tags"` // OpenShiftClusterProperties - The cluster properties. *OpenShiftClusterProperties `json:"properties,omitempty"` // SystemData - READ-ONLY; The system meta data relating to this resource. SystemData *SystemData `json:"systemData,omitempty"` }
OpenShiftClusterUpdate openShiftCluster represents an Azure Red Hat OpenShift cluster.
func (OpenShiftClusterUpdate) MarshalJSON ¶
func (oscu OpenShiftClusterUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OpenShiftClusterUpdate.
func (*OpenShiftClusterUpdate) UnmarshalJSON ¶
func (oscu *OpenShiftClusterUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for OpenShiftClusterUpdate struct.
type OpenShiftClustersClient ¶
type OpenShiftClustersClient struct {
BaseClient
}
OpenShiftClustersClient is the rest API for Azure Red Hat OpenShift 4
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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (OpenShiftClustersClient) CreateOrUpdate ¶
func (client OpenShiftClustersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, parameters OpenShiftCluster) (result OpenShiftClustersCreateOrUpdateFuture, err error)
CreateOrUpdate the operation returns properties of a OpenShift cluster. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. 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 the operation returns nothing. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. 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 the operation returns properties of a OpenShift cluster. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. resourceName - the name of the OpenShift cluster resource.
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 OpenShiftClusterListPage, err error)
List the operation returns properties of each OpenShift cluster.
func (OpenShiftClustersClient) ListAdminCredentials ¶
func (client OpenShiftClustersClient) ListAdminCredentials(ctx context.Context, resourceGroupName string, resourceName string) (result OpenShiftClusterAdminKubeconfig, err error)
ListAdminCredentials the operation returns the admin kubeconfig. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. resourceName - the name of the OpenShift cluster resource.
func (OpenShiftClustersClient) ListAdminCredentialsPreparer ¶
func (client OpenShiftClustersClient) ListAdminCredentialsPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
ListAdminCredentialsPreparer prepares the ListAdminCredentials request.
func (OpenShiftClustersClient) ListAdminCredentialsResponder ¶
func (client OpenShiftClustersClient) ListAdminCredentialsResponder(resp *http.Response) (result OpenShiftClusterAdminKubeconfig, err error)
ListAdminCredentialsResponder handles the response to the ListAdminCredentials request. The method always closes the http.Response Body.
func (OpenShiftClustersClient) ListAdminCredentialsSender ¶
func (client OpenShiftClustersClient) ListAdminCredentialsSender(req *http.Request) (*http.Response, error)
ListAdminCredentialsSender sends the ListAdminCredentials request. The method will close the http.Response Body if it receives an error.
func (OpenShiftClustersClient) ListByResourceGroup ¶
func (client OpenShiftClustersClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result OpenShiftClusterListPage, err error)
ListByResourceGroup the operation returns properties of each OpenShift cluster. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive.
func (OpenShiftClustersClient) ListByResourceGroupComplete ¶
func (client OpenShiftClustersClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result OpenShiftClusterListIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
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) ListComplete ¶
func (client OpenShiftClustersClient) ListComplete(ctx context.Context) (result OpenShiftClusterListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (OpenShiftClustersClient) ListCredentials ¶
func (client OpenShiftClustersClient) ListCredentials(ctx context.Context, resourceGroupName string, resourceName string) (result OpenShiftClusterCredentials, err error)
ListCredentials the operation returns the credentials. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. resourceName - the name of the OpenShift cluster resource.
func (OpenShiftClustersClient) ListCredentialsPreparer ¶
func (client OpenShiftClustersClient) ListCredentialsPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
ListCredentialsPreparer prepares the ListCredentials request.
func (OpenShiftClustersClient) ListCredentialsResponder ¶
func (client OpenShiftClustersClient) ListCredentialsResponder(resp *http.Response) (result OpenShiftClusterCredentials, err error)
ListCredentialsResponder handles the response to the ListCredentials request. The method always closes the http.Response Body.
func (OpenShiftClustersClient) ListCredentialsSender ¶
func (client OpenShiftClustersClient) ListCredentialsSender(req *http.Request) (*http.Response, error)
ListCredentialsSender sends the ListCredentials 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 OpenShiftClusterUpdate) (result OpenShiftClustersUpdateFuture, err error)
Update the operation returns properties of a OpenShift cluster. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. 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 OpenShiftClusterUpdate) (*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 ¶
type OpenShiftClustersCreateOrUpdateFuture struct { azure.FutureAPI // Result returns the result of the asynchronous operation. // If the operation has not completed it will return an error. Result func(OpenShiftClustersClient) (OpenShiftCluster, error) }
OpenShiftClustersCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*OpenShiftClustersCreateOrUpdateFuture) UnmarshalJSON ¶
func (future *OpenShiftClustersCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
type OpenShiftClustersDeleteFuture ¶
type OpenShiftClustersDeleteFuture struct { azure.FutureAPI // Result returns the result of the asynchronous operation. // If the operation has not completed it will return an error. Result func(OpenShiftClustersClient) (autorest.Response, error) }
OpenShiftClustersDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*OpenShiftClustersDeleteFuture) UnmarshalJSON ¶
func (future *OpenShiftClustersDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
type OpenShiftClustersUpdateFuture ¶
type OpenShiftClustersUpdateFuture struct { azure.FutureAPI // Result returns the result of the asynchronous operation. // If the operation has not completed it will return an error. Result func(OpenShiftClustersClient) (OpenShiftCluster, error) }
OpenShiftClustersUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*OpenShiftClustersUpdateFuture) UnmarshalJSON ¶
func (future *OpenShiftClustersUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
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"` // Origin - Sources of requests to this operation. Comma separated list with valid values user or system, e.g. "user,system". Origin *string `json:"origin,omitempty"` }
Operation operation represents an RP operation.
type OperationList ¶
type OperationList struct { autorest.Response `json:"-"` // Value - List of operations supported by the resource provider. Value *[]Operation `json:"value,omitempty"` // NextLink - The link used to get the next page of operations. NextLink *string `json:"nextLink,omitempty"` }
OperationList operationList represents an RP operation list.
func (OperationList) IsEmpty ¶
func (ol OperationList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type OperationListIterator ¶
type OperationListIterator struct {
// contains filtered or unexported fields
}
OperationListIterator provides access to a complete listing of Operation values.
func NewOperationListIterator ¶
func NewOperationListIterator(page OperationListPage) OperationListIterator
Creates a new instance of the OperationListIterator type.
func (*OperationListIterator) Next ¶
func (iter *OperationListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*OperationListIterator) NextWithContext ¶
func (iter *OperationListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (OperationListIterator) NotDone ¶
func (iter OperationListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (OperationListIterator) Response ¶
func (iter OperationListIterator) Response() OperationList
Response returns the raw server response from the last page request.
func (OperationListIterator) Value ¶
func (iter OperationListIterator) Value() Operation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type OperationListPage ¶
type OperationListPage struct {
// contains filtered or unexported fields
}
OperationListPage contains a page of Operation values.
func NewOperationListPage ¶
func NewOperationListPage(cur OperationList, getNextPage func(context.Context, OperationList) (OperationList, error)) OperationListPage
Creates a new instance of the OperationListPage type.
func (*OperationListPage) Next ¶
func (page *OperationListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*OperationListPage) NextWithContext ¶
func (page *OperationListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (OperationListPage) NotDone ¶
func (page OperationListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (OperationListPage) Response ¶
func (page OperationListPage) Response() OperationList
Response returns the raw server response from the last page request.
func (OperationListPage) Values ¶
func (page OperationListPage) Values() []Operation
Values returns the slice of values for the current page or nil if there are no values.
type OperationsClient ¶
type OperationsClient struct {
BaseClient
}
OperationsClient is the rest API for Azure Red Hat OpenShift 4
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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (OperationsClient) List ¶
func (client OperationsClient) List(ctx context.Context) (result OperationListPage, err error)
List the operation returns the RP operations.
func (OperationsClient) ListComplete ¶
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
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 ProvisioningState ¶
type ProvisioningState string
ProvisioningState enumerates the values for provisioning state.
const ( // ProvisioningStateAdminUpdating ... ProvisioningStateAdminUpdating ProvisioningState = "AdminUpdating" // ProvisioningStateCreating ... ProvisioningStateCreating ProvisioningState = "Creating" // ProvisioningStateDeleting ... ProvisioningStateDeleting ProvisioningState = "Deleting" // ProvisioningStateFailed ... ProvisioningStateFailed ProvisioningState = "Failed" // ProvisioningStateSucceeded ... ProvisioningStateSucceeded ProvisioningState = "Succeeded" // ProvisioningStateUpdating ... ProvisioningStateUpdating ProvisioningState = "Updating" )
func PossibleProvisioningStateValues ¶
func PossibleProvisioningStateValues() []ProvisioningState
PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.
type ProxyResource ¶
type ProxyResource struct { // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ID *string `json:"id,omitempty"` // Name - READ-ONLY; The name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" Type *string `json:"type,omitempty"` }
ProxyResource the resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
func (ProxyResource) MarshalJSON ¶
func (pr ProxyResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProxyResource.
type Resource ¶
type Resource struct { // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ID *string `json:"id,omitempty"` // Name - READ-ONLY; The name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" Type *string `json:"type,omitempty"` }
Resource common fields that are returned in the response for all Azure Resource Manager resources
func (Resource) MarshalJSON ¶
MarshalJSON is the custom marshaler for Resource.
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 SystemData ¶
type SystemData struct { // CreatedBy - The identity that created the resource. CreatedBy *string `json:"createdBy,omitempty"` // CreatedByType - The type of identity that created the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey' CreatedByType CreatedByType `json:"createdByType,omitempty"` // CreatedAt - The timestamp of resource creation (UTC). CreatedAt *date.Time `json:"createdAt,omitempty"` // LastModifiedBy - The identity that last modified the resource. LastModifiedBy *string `json:"lastModifiedBy,omitempty"` // LastModifiedByType - The type of identity that last modified the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey' LastModifiedByType CreatedByType `json:"lastModifiedByType,omitempty"` // LastModifiedAt - The timestamp of resource last modification (UTC) LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"` }
SystemData metadata pertaining to creation and last modification of the resource.
type TrackedResource ¶
type TrackedResource struct { // Tags - Resource tags. Tags map[string]*string `json:"tags"` // Location - The geo-location where the resource lives Location *string `json:"location,omitempty"` // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ID *string `json:"id,omitempty"` // Name - READ-ONLY; The name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" Type *string `json:"type,omitempty"` }
TrackedResource the resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
func (TrackedResource) MarshalJSON ¶
func (tr TrackedResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TrackedResource.
type Visibility ¶
type Visibility string
Visibility enumerates the values for visibility.
const ( // VisibilityPrivate ... VisibilityPrivate Visibility = "Private" // VisibilityPublic ... VisibilityPublic Visibility = "Public" )
func PossibleVisibilityValues ¶
func PossibleVisibilityValues() []Visibility
PossibleVisibilityValues returns an array of possible values for the Visibility const type.
type WorkerProfile ¶
type WorkerProfile struct { // Name - The worker profile name. Name *string `json:"name,omitempty"` // VMSize - The size of the worker VMs. VMSize *string `json:"vmSize,omitempty"` // DiskSizeGB - The disk size of the worker VMs. DiskSizeGB *int32 `json:"diskSizeGB,omitempty"` // SubnetID - The Azure resource ID of the worker subnet. SubnetID *string `json:"subnetId,omitempty"` // Count - The number of worker VMs. Count *int32 `json:"count,omitempty"` // EncryptionAtHost - Whether master virtual machines are encrypted at host. Possible values include: 'EncryptionAtHostDisabled', 'EncryptionAtHostEnabled' EncryptionAtHost EncryptionAtHost `json:"encryptionAtHost,omitempty"` // DiskEncryptionSetID - The resource ID of an associated DiskEncryptionSet, if applicable. DiskEncryptionSetID *string `json:"diskEncryptionSetId,omitempty"` }
WorkerProfile workerProfile represents a worker profile.
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Deprecated: Please note, this package has been deprecated.
|
Deprecated: Please note, this package has been deprecated. |