armportal

package module
Version: v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 17, 2022 License: MIT Imports: 14 Imported by: 3

README

Azure Portal Module for Go

PkgGoDev

The armportal module provides operations for working with Azure Portal.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Portal module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/portal/armportal

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Portal. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure Portal modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client, err := armportal.NewDashboardsClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
client, err := armportal.NewDashboardsClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Portal label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Configuration 

type Configuration struct {
	// Tenant configuration properties.
	Properties *ConfigurationProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Configuration - Tenant configuration.

type ConfigurationList 

type ConfigurationList struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// The array of tenant configurations.
	Value []*Configuration `json:"value,omitempty"`
}

ConfigurationList - List of tenant configurations.

type ConfigurationName 

type ConfigurationName string
const (
	ConfigurationNameDefault ConfigurationName = "default"
)

func PossibleConfigurationNameValues 

func PossibleConfigurationNameValues() []ConfigurationName

PossibleConfigurationNameValues returns the possible values for the ConfigurationName const type.

type ConfigurationProperties 

type ConfigurationProperties struct {
	// When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration
	// will be prohibited.
	EnforcePrivateMarkdownStorage *bool `json:"enforcePrivateMarkdownStorage,omitempty"`
}

ConfigurationProperties - Tenant configuration properties.

type Dashboard 

type Dashboard struct {
	// REQUIRED; Resource location
	Location *string `json:"location,omitempty"`

	// The shared dashboard properties.
	Properties *DashboardProperties `json:"properties,omitempty"`

	// Resource tags
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type
	Type *string `json:"type,omitempty" azure:"ro"`
}

Dashboard - The shared dashboard resource definition.

func (Dashboard) MarshalJSON 

func (d Dashboard) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Dashboard.

type DashboardLens 

type DashboardLens struct {
	// REQUIRED; The lens order.
	Order *int32 `json:"order,omitempty"`

	// REQUIRED; The dashboard parts.
	Parts []*DashboardParts `json:"parts,omitempty"`

	// The dashboard len's metadata.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
}

DashboardLens - A dashboard lens.

func (DashboardLens) MarshalJSON 

func (d DashboardLens) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DashboardLens.

type DashboardListResult 

type DashboardListResult struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// The array of custom resource provider manifests.
	Value []*Dashboard `json:"value,omitempty"`
}

DashboardListResult - List of dashboards.

type DashboardPartMetadata 

type DashboardPartMetadata struct {
	// REQUIRED; The type of dashboard part.
	Type *string `json:"type,omitempty"`

	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]interface{}
}

DashboardPartMetadata - A dashboard part metadata.

func (*DashboardPartMetadata) GetDashboardPartMetadata 

func (d *DashboardPartMetadata) GetDashboardPartMetadata() *DashboardPartMetadata

GetDashboardPartMetadata implements the DashboardPartMetadataClassification interface for type DashboardPartMetadata.

func (DashboardPartMetadata) MarshalJSON added in v0.2.0 

func (d DashboardPartMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DashboardPartMetadata.

func (*DashboardPartMetadata) UnmarshalJSON 

func (d *DashboardPartMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DashboardPartMetadata.

type DashboardPartMetadataClassification 

type DashboardPartMetadataClassification interface {
	// GetDashboardPartMetadata returns the DashboardPartMetadata content of the underlying type.
	GetDashboardPartMetadata() *DashboardPartMetadata
}

DashboardPartMetadataClassification provides polymorphic access to related types. Call the interface's GetDashboardPartMetadata() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *DashboardPartMetadata, *MarkdownPartMetadata

type DashboardParts 

type DashboardParts struct {
	// REQUIRED; The dashboard's part position.
	Position *DashboardPartsPosition `json:"position,omitempty"`

	// The dashboard part's metadata.
	Metadata DashboardPartMetadataClassification `json:"metadata,omitempty"`
}

DashboardParts - A dashboard part.

func (DashboardParts) MarshalJSON 

func (d DashboardParts) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DashboardParts.

func (*DashboardParts) UnmarshalJSON 

func (d *DashboardParts) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DashboardParts.

type DashboardPartsPosition 

type DashboardPartsPosition struct {
	// REQUIRED; The dashboard's part column span.
	ColSpan *int32 `json:"colSpan,omitempty"`

	// REQUIRED; The dashboard's part row span.
	RowSpan *int32 `json:"rowSpan,omitempty"`

	// REQUIRED; The dashboard's part x coordinate.
	X *int32 `json:"x,omitempty"`

	// REQUIRED; The dashboard's part y coordinate.
	Y *int32 `json:"y,omitempty"`

	// The dashboard part's metadata.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
}

DashboardPartsPosition - The dashboard's part position.

func (DashboardPartsPosition) MarshalJSON 

func (d DashboardPartsPosition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DashboardPartsPosition.

type DashboardProperties 

type DashboardProperties struct {
	// The dashboard lenses.
	Lenses []*DashboardLens `json:"lenses,omitempty"`

	// The dashboard metadata.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
}

DashboardProperties - The shared dashboard properties.

func (DashboardProperties) MarshalJSON 

func (d DashboardProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DashboardProperties.

type DashboardsClient 

type DashboardsClient struct {
	// contains filtered or unexported fields
}

DashboardsClient contains the methods for the Dashboards group. Don't use this type directly, use NewDashboardsClient() instead.

func NewDashboardsClient 

func NewDashboardsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DashboardsClient, error)

NewDashboardsClient creates a new instance of DashboardsClient with the specified values. subscriptionID - The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DashboardsClient) CreateOrUpdate 

func (client *DashboardsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, dashboardName string, dashboard Dashboard, options *DashboardsClientCreateOrUpdateOptions) (DashboardsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a Dashboard. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-09-01-preview resourceGroupName - The name of the resource group. dashboardName - The name of the dashboard. dashboard - The parameters required to create or update a dashboard. options - DashboardsClientCreateOrUpdateOptions contains the optional parameters for the DashboardsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/createOrUpdateDashboard.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/portal/armportal"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armportal.NewDashboardsClient("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"testRG",
		"testDashboard",
		armportal.Dashboard{
			Location: to.Ptr("eastus"),
			Properties: &armportal.DashboardProperties{
				Lenses: []*armportal.DashboardLens{
					{
						Order: to.Ptr[int32](1),
						Parts: []*armportal.DashboardParts{
							{
								Position: &armportal.DashboardPartsPosition{
									ColSpan: to.Ptr[int32](3),
									RowSpan: to.Ptr[int32](4),
									X:       to.Ptr[int32](1),
									Y:       to.Ptr[int32](2),
								},
							},
							{
								Position: &armportal.DashboardPartsPosition{
									ColSpan: to.Ptr[int32](6),
									RowSpan: to.Ptr[int32](6),
									X:       to.Ptr[int32](5),
									Y:       to.Ptr[int32](5),
								},
							}},
					},
					{
						Order: to.Ptr[int32](2),
						Parts: []*armportal.DashboardParts{},
					}},
				Metadata: map[string]interface{}{
					"metadata": map[string]interface{}{
						"ColSpan": float64(2),
						"RowSpan": float64(1),
						"X":       float64(4),
						"Y":       float64(3),
					},
				},
			},
			Tags: map[string]*string{
				"aKey":       to.Ptr("aValue"),
				"anotherKey": to.Ptr("anotherValue"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*DashboardsClient) Delete 

func (client *DashboardsClient) Delete(ctx context.Context, resourceGroupName string, dashboardName string, options *DashboardsClientDeleteOptions) (DashboardsClientDeleteResponse, error)

Delete - Deletes the Dashboard. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-09-01-preview resourceGroupName - The name of the resource group. dashboardName - The name of the dashboard. options - DashboardsClientDeleteOptions contains the optional parameters for the DashboardsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/deleteDashboard.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/portal/armportal"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armportal.NewDashboardsClient("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"testRG",
		"testDashboard",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*DashboardsClient) Get 

func (client *DashboardsClient) Get(ctx context.Context, resourceGroupName string, dashboardName string, options *DashboardsClientGetOptions) (DashboardsClientGetResponse, error)

Get - Gets the Dashboard. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-09-01-preview resourceGroupName - The name of the resource group. dashboardName - The name of the dashboard. options - DashboardsClientGetOptions contains the optional parameters for the DashboardsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/getDashboard.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/portal/armportal"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armportal.NewDashboardsClient("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"testRG",
		"testDashboard",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*DashboardsClient) NewListByResourceGroupPager added in v0.4.0 

func (client *DashboardsClient) NewListByResourceGroupPager(resourceGroupName string, options *DashboardsClientListByResourceGroupOptions) *runtime.Pager[DashboardsClientListByResourceGroupResponse]

NewListByResourceGroupPager - Gets all the Dashboards within a resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-09-01-preview resourceGroupName - The name of the resource group. options - DashboardsClientListByResourceGroupOptions contains the optional parameters for the DashboardsClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/listDashboardsByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/portal/armportal"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armportal.NewDashboardsClient("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourceGroupPager("testRG",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*DashboardsClient) NewListBySubscriptionPager added in v0.4.0 

func (client *DashboardsClient) NewListBySubscriptionPager(options *DashboardsClientListBySubscriptionOptions) *runtime.Pager[DashboardsClientListBySubscriptionResponse]

NewListBySubscriptionPager - Gets all the dashboards within a subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-09-01-preview options - DashboardsClientListBySubscriptionOptions contains the optional parameters for the DashboardsClient.ListBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/listDashboardsBySubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/portal/armportal"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armportal.NewDashboardsClient("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListBySubscriptionPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*DashboardsClient) Update 

func (client *DashboardsClient) Update(ctx context.Context, resourceGroupName string, dashboardName string, dashboard PatchableDashboard, options *DashboardsClientUpdateOptions) (DashboardsClientUpdateResponse, error)

Update - Updates an existing Dashboard. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-09-01-preview resourceGroupName - The name of the resource group. dashboardName - The name of the dashboard. dashboard - The updatable fields of a Dashboard. options - DashboardsClientUpdateOptions contains the optional parameters for the DashboardsClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/updateDashboard.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/portal/armportal"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armportal.NewDashboardsClient("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"testRG",
		"testDashboard",
		armportal.PatchableDashboard{
			Tags: map[string]*string{
				"aKey":       to.Ptr("bValue"),
				"anotherKey": to.Ptr("anotherValue2"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type DashboardsClientCreateOrUpdateOptions added in v0.2.0 

type DashboardsClientCreateOrUpdateOptions struct {
}

DashboardsClientCreateOrUpdateOptions contains the optional parameters for the DashboardsClient.CreateOrUpdate method.

type DashboardsClientCreateOrUpdateResponse added in v0.2.0 

type DashboardsClientCreateOrUpdateResponse struct {
	Dashboard
}

DashboardsClientCreateOrUpdateResponse contains the response from method DashboardsClient.CreateOrUpdate.

type DashboardsClientDeleteOptions added in v0.2.0 

type DashboardsClientDeleteOptions struct {
}

DashboardsClientDeleteOptions contains the optional parameters for the DashboardsClient.Delete method.

type DashboardsClientDeleteResponse added in v0.2.0 

type DashboardsClientDeleteResponse struct {
}

DashboardsClientDeleteResponse contains the response from method DashboardsClient.Delete.

type DashboardsClientGetOptions added in v0.2.0 

type DashboardsClientGetOptions struct {
}

DashboardsClientGetOptions contains the optional parameters for the DashboardsClient.Get method.

type DashboardsClientGetResponse added in v0.2.0 

type DashboardsClientGetResponse struct {
	Dashboard
}

DashboardsClientGetResponse contains the response from method DashboardsClient.Get.

type DashboardsClientListByResourceGroupOptions added in v0.2.0 

type DashboardsClientListByResourceGroupOptions struct {
}

DashboardsClientListByResourceGroupOptions contains the optional parameters for the DashboardsClient.ListByResourceGroup method.

type DashboardsClientListByResourceGroupResponse added in v0.2.0 

type DashboardsClientListByResourceGroupResponse struct {
	DashboardListResult
}

DashboardsClientListByResourceGroupResponse contains the response from method DashboardsClient.ListByResourceGroup.

type DashboardsClientListBySubscriptionOptions added in v0.2.0 

type DashboardsClientListBySubscriptionOptions struct {
}

DashboardsClientListBySubscriptionOptions contains the optional parameters for the DashboardsClient.ListBySubscription method.

type DashboardsClientListBySubscriptionResponse added in v0.2.0 

type DashboardsClientListBySubscriptionResponse struct {
	DashboardListResult
}

DashboardsClientListBySubscriptionResponse contains the response from method DashboardsClient.ListBySubscription.

type DashboardsClientUpdateOptions added in v0.2.0 

type DashboardsClientUpdateOptions struct {
}

DashboardsClientUpdateOptions contains the optional parameters for the DashboardsClient.Update method.

type DashboardsClientUpdateResponse added in v0.2.0 

type DashboardsClientUpdateResponse struct {
	Dashboard
}

DashboardsClientUpdateResponse contains the response from method DashboardsClient.Update.

type ErrorDefinition 

type ErrorDefinition struct {
	// READ-ONLY; Service specific error code which serves as the substatus for the HTTP error code.
	Code *int32 `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; Internal error details.
	Details []*ErrorDefinition `json:"details,omitempty" azure:"ro"`

	// READ-ONLY; Description of the error.
	Message *string `json:"message,omitempty" azure:"ro"`
}

ErrorDefinition - Error definition.

type ErrorResponse 

type ErrorResponse struct {
	// The error details.
	Error *ErrorDefinition `json:"error,omitempty"`
}

ErrorResponse - Error response.

type ListTenantConfigurationViolationsClient 

type ListTenantConfigurationViolationsClient struct {
	// contains filtered or unexported fields
}

ListTenantConfigurationViolationsClient contains the methods for the ListTenantConfigurationViolations group. Don't use this type directly, use NewListTenantConfigurationViolationsClient() instead.

func NewListTenantConfigurationViolationsClient 

func NewListTenantConfigurationViolationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*ListTenantConfigurationViolationsClient, error)

NewListTenantConfigurationViolationsClient creates a new instance of ListTenantConfigurationViolationsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ListTenantConfigurationViolationsClient) NewListPager added in v0.4.0 

func (client *ListTenantConfigurationViolationsClient) NewListPager(options *ListTenantConfigurationViolationsClientListOptions) *runtime.Pager[ListTenantConfigurationViolationsClientListResponse]

NewListPager - Gets list of items that violate tenant's configuration. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-09-01-preview options - ListTenantConfigurationViolationsClientListOptions contains the optional parameters for the ListTenantConfigurationViolationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetListOfTenantConfigurationViolations.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/portal/armportal"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armportal.NewListTenantConfigurationViolationsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type ListTenantConfigurationViolationsClientListOptions added in v0.2.0 

type ListTenantConfigurationViolationsClientListOptions struct {
}

ListTenantConfigurationViolationsClientListOptions contains the optional parameters for the ListTenantConfigurationViolationsClient.List method.

type ListTenantConfigurationViolationsClientListResponse added in v0.2.0 

type ListTenantConfigurationViolationsClientListResponse struct {
	ViolationsList
}

ListTenantConfigurationViolationsClientListResponse contains the response from method ListTenantConfigurationViolationsClient.List.

type MarkdownPartMetadata 

type MarkdownPartMetadata struct {
	// REQUIRED; The type of dashboard part.
	Type *string `json:"type,omitempty"`

	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]interface{}

	// Input to dashboard part.
	Inputs []interface{} `json:"inputs,omitempty"`

	// Markdown part settings.
	Settings *MarkdownPartMetadataSettings `json:"settings,omitempty"`
}

MarkdownPartMetadata - Markdown part metadata.

func (*MarkdownPartMetadata) GetDashboardPartMetadata added in v0.2.0 

func (m *MarkdownPartMetadata) GetDashboardPartMetadata() *DashboardPartMetadata

GetDashboardPartMetadata implements the DashboardPartMetadataClassification interface for type MarkdownPartMetadata.

func (MarkdownPartMetadata) MarshalJSON 

func (m MarkdownPartMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MarkdownPartMetadata.

func (*MarkdownPartMetadata) UnmarshalJSON 

func (m *MarkdownPartMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MarkdownPartMetadata.

type MarkdownPartMetadataSettings 

type MarkdownPartMetadataSettings struct {
	// The content of markdown part.
	Content *MarkdownPartMetadataSettingsContent `json:"content,omitempty"`
}

MarkdownPartMetadataSettings - Markdown part settings.

type MarkdownPartMetadataSettingsContent 

type MarkdownPartMetadataSettingsContent struct {
	// The setting of the content of markdown part.
	Settings *MarkdownPartMetadataSettingsContentSettings `json:"settings,omitempty"`
}

MarkdownPartMetadataSettingsContent - The content of markdown part.

type MarkdownPartMetadataSettingsContentSettings 

type MarkdownPartMetadataSettingsContentSettings struct {
	// The content of the markdown part.
	Content *string `json:"content,omitempty"`

	// The source of the content of the markdown part.
	MarkdownSource *int32 `json:"markdownSource,omitempty"`

	// The uri of markdown content.
	MarkdownURI *string `json:"markdownUri,omitempty"`

	// The subtitle of the markdown part.
	Subtitle *string `json:"subtitle,omitempty"`

	// The title of the markdown part.
	Title *string `json:"title,omitempty"`
}

MarkdownPartMetadataSettingsContentSettings - The setting of the content of markdown part.

type OperationsClient 

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationsClient) NewListPager added in v0.4.0 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - The Microsoft Portal operations API. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-09-01-preview options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/operationsList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/portal/armportal"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armportal.NewOperationsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type OperationsClientListOptions added in v0.2.0 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListResponse added in v0.2.0 

type OperationsClientListResponse struct {
	ResourceProviderOperationList
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type PatchableDashboard 

type PatchableDashboard struct {
	// The shared dashboard properties.
	Properties *DashboardProperties `json:"properties,omitempty"`

	// Resource tags
	Tags map[string]*string `json:"tags,omitempty"`
}

PatchableDashboard - The shared dashboard resource definition.

func (PatchableDashboard) MarshalJSON 

func (p PatchableDashboard) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PatchableDashboard.

type ProxyResource 

type ProxyResource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

ProxyResource - The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

type Resource 

type Resource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - Common fields that are returned in the response for all Azure Resource Manager resources

type ResourceProviderOperation 

type ResourceProviderOperation struct {
	// Display metadata associated with the operation.
	Display *ResourceProviderOperationDisplay `json:"display,omitempty"`

	// Indicates whether the operation applies to data-plane.
	IsDataAction *string `json:"isDataAction,omitempty"`

	// Operation name, in format of {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`
}

ResourceProviderOperation - Supported operations of this resource provider.

type ResourceProviderOperationDisplay 

type ResourceProviderOperationDisplay struct {
	// Description of this operation.
	Description *string `json:"description,omitempty"`

	// Type of operation: get, read, delete, etc.
	Operation *string `json:"operation,omitempty"`

	// Resource provider: Microsoft Custom Providers.
	Provider *string `json:"provider,omitempty"`

	// Resource on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
}

ResourceProviderOperationDisplay - Display metadata associated with the operation.

type ResourceProviderOperationList 

type ResourceProviderOperationList struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of operations supported by this resource provider.
	Value []*ResourceProviderOperation `json:"value,omitempty"`
}

ResourceProviderOperationList - Results of the request to list operations.

type TenantConfigurationsClient 

type TenantConfigurationsClient struct {
	// contains filtered or unexported fields
}

TenantConfigurationsClient contains the methods for the TenantConfigurations group. Don't use this type directly, use NewTenantConfigurationsClient() instead.

func NewTenantConfigurationsClient 

func NewTenantConfigurationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*TenantConfigurationsClient, error)

NewTenantConfigurationsClient creates a new instance of TenantConfigurationsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*TenantConfigurationsClient) Create 

func (client *TenantConfigurationsClient) Create(ctx context.Context, configurationName ConfigurationName, tenantConfiguration Configuration, options *TenantConfigurationsClientCreateOptions) (TenantConfigurationsClientCreateResponse, error)

Create - Create the tenant configuration. If configuration already exists - update it. User has to be a Tenant Admin for this operation. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-09-01-preview configurationName - The configuration name. Value must be 'default' tenantConfiguration - The parameters required to create or update tenant configuration. options - TenantConfigurationsClientCreateOptions contains the optional parameters for the TenantConfigurationsClient.Create method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/CreateOrUpdateTenantConfiguration.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/portal/armportal"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armportal.NewTenantConfigurationsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Create(ctx,
		armportal.ConfigurationNameDefault,
		armportal.Configuration{
			Properties: &armportal.ConfigurationProperties{
				EnforcePrivateMarkdownStorage: to.Ptr(true),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*TenantConfigurationsClient) Delete 

func (client *TenantConfigurationsClient) Delete(ctx context.Context, configurationName ConfigurationName, options *TenantConfigurationsClientDeleteOptions) (TenantConfigurationsClientDeleteResponse, error)

Delete - Delete the tenant configuration. User has to be a Tenant Admin for this operation. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-09-01-preview configurationName - The configuration name. Value must be 'default' options - TenantConfigurationsClientDeleteOptions contains the optional parameters for the TenantConfigurationsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/DeleteTenantConfiguration.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/portal/armportal"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armportal.NewTenantConfigurationsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		armportal.ConfigurationNameDefault,
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*TenantConfigurationsClient) Get 

func (client *TenantConfigurationsClient) Get(ctx context.Context, configurationName ConfigurationName, options *TenantConfigurationsClientGetOptions) (TenantConfigurationsClientGetResponse, error)

Get - Gets the tenant configuration. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-09-01-preview configurationName - The configuration name. Value must be 'default' options - TenantConfigurationsClientGetOptions contains the optional parameters for the TenantConfigurationsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetTenantConfiguration.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/portal/armportal"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armportal.NewTenantConfigurationsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		armportal.ConfigurationNameDefault,
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*TenantConfigurationsClient) NewListPager added in v0.4.0 

func (client *TenantConfigurationsClient) NewListPager(options *TenantConfigurationsClientListOptions) *runtime.Pager[TenantConfigurationsClientListResponse]

NewListPager - Gets list of the tenant configurations. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2020-09-01-preview options - TenantConfigurationsClientListOptions contains the optional parameters for the TenantConfigurationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetListOfTenantConfigurations.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/portal/armportal"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armportal.NewTenantConfigurationsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type TenantConfigurationsClientCreateOptions added in v0.2.0 

type TenantConfigurationsClientCreateOptions struct {
}

TenantConfigurationsClientCreateOptions contains the optional parameters for the TenantConfigurationsClient.Create method.

type TenantConfigurationsClientCreateResponse added in v0.2.0 

type TenantConfigurationsClientCreateResponse struct {
	Configuration
}

TenantConfigurationsClientCreateResponse contains the response from method TenantConfigurationsClient.Create.

type TenantConfigurationsClientDeleteOptions added in v0.2.0 

type TenantConfigurationsClientDeleteOptions struct {
}

TenantConfigurationsClientDeleteOptions contains the optional parameters for the TenantConfigurationsClient.Delete method.

type TenantConfigurationsClientDeleteResponse added in v0.2.0 

type TenantConfigurationsClientDeleteResponse struct {
}

TenantConfigurationsClientDeleteResponse contains the response from method TenantConfigurationsClient.Delete.

type TenantConfigurationsClientGetOptions added in v0.2.0 

type TenantConfigurationsClientGetOptions struct {
}

TenantConfigurationsClientGetOptions contains the optional parameters for the TenantConfigurationsClient.Get method.

type TenantConfigurationsClientGetResponse added in v0.2.0 

type TenantConfigurationsClientGetResponse struct {
	Configuration
}

TenantConfigurationsClientGetResponse contains the response from method TenantConfigurationsClient.Get.

type TenantConfigurationsClientListOptions added in v0.2.0 

type TenantConfigurationsClientListOptions struct {
}

TenantConfigurationsClientListOptions contains the optional parameters for the TenantConfigurationsClient.List method.

type TenantConfigurationsClientListResponse added in v0.2.0 

type TenantConfigurationsClientListResponse struct {
	ConfigurationList
}

TenantConfigurationsClientListResponse contains the response from method TenantConfigurationsClient.List.

type Violation 

type Violation struct {
	// READ-ONLY; Error message.
	ErrorMessage *string `json:"errorMessage,omitempty" azure:"ro"`

	// READ-ONLY; Id of the item that violates tenant configuration.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Id of the user who owns violated item.
	UserID *string `json:"userId,omitempty" azure:"ro"`
}

Violation information.

type ViolationsList 

type ViolationsList struct {
	// The URL to use for getting the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// The array of violations.
	Value []*Violation `json:"value,omitempty"`
}

ViolationsList - List of list of items that violate tenant's configuration.

Source Files

View all

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.