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/security/2020-01-01/topology Documentation

The topology SDK allows for interaction with the Azure Resource Manager Service security (API Version 2020-01-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/security/2020-01-01/topology"

Client Initialization

client := topology.NewTopologyClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TopologyClient.Get

ctx := context.TODO()
id := topology.NewTopologyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "locationValue", "topologyValue")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: TopologyClient.List

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: TopologyClient.ListByHomeRegion

ctx := context.TODO()
id := topology.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

// alternatively `client.ListByHomeRegion(ctx, id)` can be used to do batched pagination
items, err := client.ListByHomeRegionComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

# Functions

NewLocationID returns a new LocationId struct.
No description provided by the author
NewTopologyID returns a new TopologyId struct.
ParseLocationID parses 'input' into a LocationId.
ParseLocationIDInsensitively parses 'input' case-insensitively into a LocationId note: this method should only be used for API response data and not user input.
ParseTopologyID parses 'input' into a TopologyId.
ParseTopologyIDInsensitively parses 'input' case-insensitively into a TopologyId note: this method should only be used for API response data and not user input.
ValidateLocationID checks that 'input' can be parsed as a Location ID.
ValidateTopologyID checks that 'input' can be parsed as a Topology ID.

# Structs

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
LocationId is a struct representing the Resource ID for a Location.
No description provided by the author
TopologyId is a struct representing the Resource ID for a Topology.
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