Documentation
¶
Overview ¶
MIT License
Copyright (c) 2024 Aaron Saikovski ¶
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Index ¶
- func CheckResourceGroupExists(ctx context.Context, resourceGroupClient *armresources.ResourceGroupsClient, ...) (bool, error)
- func GetResourceGroup(ctx context.Context, resourceGroupClient *armresources.ResourceGroupsClient, ...) (*armresources.ResourceGroup, error)
- func GetResourceGroupClient(cred *azidentity.DefaultAzureCredential, subscriptionID string) (*armresources.ResourceGroupsClient, error)
- func GetResourceGroupId(ctx context.Context, resourceGroupClient *armresources.ResourceGroupsClient, ...) (*string, error)
- func ListResourceGroup(ctx context.Context, resourceGroupClient *armresources.ResourceGroupsClient) ([]*armresources.ResourceGroup, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckResourceGroupExists ¶
func CheckResourceGroupExists(ctx context.Context, resourceGroupClient *armresources.ResourceGroupsClient, resourceGroupName string) (bool, error)
CheckResourceGroupExists checks if a resource group exists.
ctx: the context for the request. resourceGroupName: the name of the resource group to check. (bool, error): returns a boolean indicating if the resource group exists and an error if any.
func GetResourceGroup ¶
func GetResourceGroup(ctx context.Context, resourceGroupClient *armresources.ResourceGroupsClient, resourceGroupName string) (*armresources.ResourceGroup, error)
GetResourceGroup retrieves a resource group using the provided resource group name.
ctx: The context within which the function is being executed. resourceGroupName: The name of the resource group to retrieve. Returns a pointer to armresources.ResourceGroup and an error. func GetResourceGroup(ctx context.Context, resourceGroupClient *armresources.ResourceGroupsClient, resourceGroupName string) (*armresources.ResourceGroup, error) {
func GetResourceGroupClient ¶
func GetResourceGroupClient(cred *azidentity.DefaultAzureCredential, subscriptionID string) (*armresources.ResourceGroupsClient, error)
GetResourceGroupClient creates a new instance of the armresources.ResourceGroupsClient for the given azidentity.DefaultAzureCredential and subscriptionID.
Parameters: - cred: The azidentity.DefaultAzureCredential used to authenticate the client. - subscriptionID: The ID of the subscription to create the client for.
Returns: - *armresources.ResourceGroupsClient: The created client instance. - error: An error if the client creation fails.
func GetResourceGroupId ¶
func GetResourceGroupId(ctx context.Context, resourceGroupClient *armresources.ResourceGroupsClient, resourceGroupName string) (*string, error)
GetResourceGroupId retrieves the ID of a resource group.
ctx: The context within which the function is being executed. resourceGroupClient: The client for interacting with Azure Resource Groups. resourceGroupName: The name of the resource group. *string, error: The ID of the resource group and an error if any.
func ListResourceGroup ¶
func ListResourceGroup(ctx context.Context, resourceGroupClient *armresources.ResourceGroupsClient) ([]*armresources.ResourceGroup, error)
ListResourceGroup fetches a list of resource groups.
ctx - the context within which the function is executed. []*armresources.ResourceGroup, error - returns a slice of resource groups and an error if any. func ListResourceGroup(ctx context.Context, resourceGroupClient *armresources.ResourceGroupsClient) ([]*armresources.ResourceGroup, error) {
Types ¶
This section is empty.
Source Files