package
0.20240715.1103416
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev
# README
github.com/hashicorp/go-azure-sdk/resource-manager/devcenter/2024-02-01/environmentdefinitions
Documentation
The environmentdefinitions
SDK allows for interaction with the Azure Resource Manager Service devcenter
(API Version 2024-02-01
).
This readme covers example usages, but further information on using this SDK can be found in the project root.
Import Path
import "github.com/hashicorp/go-azure-sdk/resource-manager/devcenter/2024-02-01/environmentdefinitions"
Client Initialization
client := environmentdefinitions.NewEnvironmentDefinitionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: EnvironmentDefinitionsClient.EnvironmentDefinitionsGet
ctx := context.TODO()
id := environmentdefinitions.NewCatalogEnvironmentDefinitionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "devCenterValue", "catalogValue", "environmentDefinitionValue")
read, err := client.EnvironmentDefinitionsGet(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: EnvironmentDefinitionsClient.EnvironmentDefinitionsGetByProjectCatalog
ctx := context.TODO()
id := environmentdefinitions.NewEnvironmentDefinitionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "projectValue", "catalogValue", "environmentDefinitionValue")
read, err := client.EnvironmentDefinitionsGetByProjectCatalog(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: EnvironmentDefinitionsClient.EnvironmentDefinitionsGetErrorDetails
ctx := context.TODO()
id := environmentdefinitions.NewCatalogEnvironmentDefinitionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "devCenterValue", "catalogValue", "environmentDefinitionValue")
read, err := client.EnvironmentDefinitionsGetErrorDetails(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: EnvironmentDefinitionsClient.EnvironmentDefinitionsListByCatalog
ctx := context.TODO()
id := environmentdefinitions.NewDevCenterCatalogID("12345678-1234-9876-4563-123456789012", "example-resource-group", "devCenterValue", "catalogValue")
// alternatively `client.EnvironmentDefinitionsListByCatalog(ctx, id, environmentdefinitions.DefaultEnvironmentDefinitionsListByCatalogOperationOptions())` can be used to do batched pagination
items, err := client.EnvironmentDefinitionsListByCatalogComplete(ctx, id, environmentdefinitions.DefaultEnvironmentDefinitionsListByCatalogOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: EnvironmentDefinitionsClient.EnvironmentDefinitionsListByProjectCatalog
ctx := context.TODO()
id := environmentdefinitions.NewCatalogID("12345678-1234-9876-4563-123456789012", "example-resource-group", "projectValue", "catalogValue")
// alternatively `client.EnvironmentDefinitionsListByProjectCatalog(ctx, id)` can be used to do batched pagination
items, err := client.EnvironmentDefinitionsListByProjectCatalogComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: EnvironmentDefinitionsClient.ProjectCatalogEnvironmentDefinitionsGetErrorDetails
ctx := context.TODO()
id := environmentdefinitions.NewEnvironmentDefinitionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "projectValue", "catalogValue", "environmentDefinitionValue")
read, err := client.ProjectCatalogEnvironmentDefinitionsGetErrorDetails(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
# Functions
No description provided by the author
NewCatalogEnvironmentDefinitionID returns a new CatalogEnvironmentDefinitionId struct.
NewCatalogID returns a new CatalogId struct.
NewDevCenterCatalogID returns a new DevCenterCatalogId struct.
NewEnvironmentDefinitionID returns a new EnvironmentDefinitionId struct.
No description provided by the author
ParseCatalogEnvironmentDefinitionID parses 'input' into a CatalogEnvironmentDefinitionId.
ParseCatalogEnvironmentDefinitionIDInsensitively parses 'input' case-insensitively into a CatalogEnvironmentDefinitionId note: this method should only be used for API response data and not user input.
ParseCatalogID parses 'input' into a CatalogId.
ParseCatalogIDInsensitively parses 'input' case-insensitively into a CatalogId note: this method should only be used for API response data and not user input.
ParseDevCenterCatalogID parses 'input' into a DevCenterCatalogId.
ParseDevCenterCatalogIDInsensitively parses 'input' case-insensitively into a DevCenterCatalogId note: this method should only be used for API response data and not user input.
ParseEnvironmentDefinitionID parses 'input' into a EnvironmentDefinitionId.
ParseEnvironmentDefinitionIDInsensitively parses 'input' case-insensitively into a EnvironmentDefinitionId note: this method should only be used for API response data and not user input.
No description provided by the author
No description provided by the author
ValidateCatalogEnvironmentDefinitionID checks that 'input' can be parsed as a Catalog Environment Definition ID.
ValidateCatalogID checks that 'input' can be parsed as a Catalog ID.
ValidateDevCenterCatalogID checks that 'input' can be parsed as a Dev Center Catalog ID.
ValidateEnvironmentDefinitionID checks that 'input' can be parsed as a Environment Definition ID.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
CatalogEnvironmentDefinitionId is a struct representing the Resource ID for a Catalog Environment Definition.
No description provided by the author
CatalogId is a struct representing the Resource ID for a Catalog.
No description provided by the author
DevCenterCatalogId is a struct representing the Resource ID for a Dev Center Catalog.
No description provided by the author
EnvironmentDefinitionId is a struct representing the Resource ID for a Environment Definition.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
No description provided by the author
No description provided by the author