armpurview

package module
v1.2.0 Latest Latest
Warning

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

 Go to latest Published: Nov 24, 2023 License: MIT Imports: 14 Imported by: 1

README

Azure Purview Module for Go

PkgGoDev

The armpurview module provides operations for working with Azure Purview.

Source code

Getting started

Prerequisites

  • an Azure subscription
  • Go 1.18 or above (You could download and install the latest version of Go from here. It will replace the existing Go on your machine. If you want to install multiple Go versions on the same machine, you could refer this doc.)

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Purview module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/purview/armpurview

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Purview. 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.

Client Factory

Azure Purview module consists of one or more clients. We provide a client factory which could be used to create any client in this module.

clientFactory, err := armpurview.NewClientFactory(<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,
    },
}
clientFactory, err := armpurview.NewClientFactory(<subscription ID>, cred, &options)

Clients

A client groups a set of related APIs, providing access to its functionality. Create one or more clients to access the APIs you require using client factory.

client := clientFactory.NewAccountsClient()

Fakes

The fake package contains types used for constructing in-memory fake servers used in unit tests. This allows writing tests to cover various success/error conditions without the need for connecting to a live service.

Please see https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/samples/fakes for details and examples on how to use fakes.

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Purview 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 AccessKeys 

type AccessKeys struct {
	// Gets or sets the primary connection string.
	AtlasKafkaPrimaryEndpoint *string

	// Gets or sets the secondary connection string.
	AtlasKafkaSecondaryEndpoint *string
}

AccessKeys - The Account access keys.

func (AccessKeys) MarshalJSON added in v1.1.0 

func (a AccessKeys) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccessKeys.

func (*AccessKeys) UnmarshalJSON added in v1.1.0 

func (a *AccessKeys) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AccessKeys.

type Account 

type Account struct {
	// Identity Info on the tracked resource
	Identity *Identity

	// Gets or sets the location.
	Location *string

	// Gets or sets the properties.
	Properties *AccountProperties

	// Tags on the azure resource.
	Tags map[string]*string

	// READ-ONLY; Gets or sets the identifier.
	ID *string

	// READ-ONLY; Gets or sets the name.
	Name *string

	// READ-ONLY; Gets or sets the Sku.
	SKU *AccountSKU

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *TrackedResourceSystemData

	// READ-ONLY; Gets or sets the type.
	Type *string
}

Account resource

func (Account) MarshalJSON 

func (a Account) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Account.

func (*Account) UnmarshalJSON added in v1.1.0 

func (a *Account) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Account.

type AccountEndpoints 

type AccountEndpoints struct {
	// READ-ONLY; Gets the catalog endpoint.
	Catalog *string

	// READ-ONLY; Gets the guardian endpoint.
	Guardian *string

	// READ-ONLY; Gets the scan endpoint.
	Scan *string
}

AccountEndpoints - The account endpoints

func (AccountEndpoints) MarshalJSON added in v1.1.0 

func (a AccountEndpoints) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccountEndpoints.

func (*AccountEndpoints) UnmarshalJSON added in v1.1.0 

func (a *AccountEndpoints) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AccountEndpoints.

type AccountList 

type AccountList struct {
	// REQUIRED; Collection of items of type results.
	Value []*Account

	// Total item count.
	Count *int64

	// The Url of next result page.
	NextLink *string
}

AccountList - Paged list of account resources

func (AccountList) MarshalJSON 

func (a AccountList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccountList.

func (*AccountList) UnmarshalJSON added in v1.1.0 

func (a *AccountList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AccountList.

type AccountProperties 

type AccountProperties struct {
	// Cloud connectors. External cloud identifier used as part of scanning configuration.
	CloudConnectors *CloudConnectors

	// Gets or sets the managed resource group name
	ManagedResourceGroupName *string

	// Gets or sets the public network access.
	PublicNetworkAccess *PublicNetworkAccess

	// READ-ONLY; Gets the time at which the entity was created.
	CreatedAt *time.Time

	// READ-ONLY; Gets the creator of the entity.
	CreatedBy *string

	// READ-ONLY; Gets the creators of the entity's object id.
	CreatedByObjectID *string

	// READ-ONLY; The URIs that are the public endpoints of the account.
	Endpoints *AccountPropertiesEndpoints

	// READ-ONLY; Gets or sets the friendly name.
	FriendlyName *string

	// READ-ONLY; Gets the resource identifiers of the managed resources.
	ManagedResources *AccountPropertiesManagedResources

	// READ-ONLY; Gets the private endpoint connections information.
	PrivateEndpointConnections []*PrivateEndpointConnection

	// READ-ONLY; Gets or sets the state of the provisioning.
	ProvisioningState *ProvisioningState
}

AccountProperties - The account properties

func (AccountProperties) MarshalJSON 

func (a AccountProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccountProperties.

func (*AccountProperties) UnmarshalJSON 

func (a *AccountProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AccountProperties.

type AccountPropertiesEndpoints 

type AccountPropertiesEndpoints struct {
	// READ-ONLY; Gets the catalog endpoint.
	Catalog *string

	// READ-ONLY; Gets the guardian endpoint.
	Guardian *string

	// READ-ONLY; Gets the scan endpoint.
	Scan *string
}

AccountPropertiesEndpoints - The URIs that are the public endpoints of the account.

func (AccountPropertiesEndpoints) MarshalJSON added in v1.1.0 

func (a AccountPropertiesEndpoints) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccountPropertiesEndpoints.

func (*AccountPropertiesEndpoints) UnmarshalJSON added in v1.1.0 

func (a *AccountPropertiesEndpoints) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AccountPropertiesEndpoints.

type AccountPropertiesManagedResources 

type AccountPropertiesManagedResources struct {
	// READ-ONLY; Gets the managed event hub namespace resource identifier.
	EventHubNamespace *string

	// READ-ONLY; Gets the managed resource group resource identifier. This resource group will host resource dependencies for
	// the account.
	ResourceGroup *string

	// READ-ONLY; Gets the managed storage account resource identifier.
	StorageAccount *string
}

AccountPropertiesManagedResources - Gets the resource identifiers of the managed resources.

func (AccountPropertiesManagedResources) MarshalJSON added in v1.1.0 

func (a AccountPropertiesManagedResources) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccountPropertiesManagedResources.

func (*AccountPropertiesManagedResources) UnmarshalJSON added in v1.1.0 

func (a *AccountPropertiesManagedResources) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AccountPropertiesManagedResources.

type AccountSKU 

type AccountSKU struct {
	// Gets or sets the sku capacity.
	Capacity *int32

	// Gets or sets the sku name.
	Name *Name
}

AccountSKU - Gets or sets the Sku.

func (AccountSKU) MarshalJSON added in v1.1.0 

func (a AccountSKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccountSKU.

func (*AccountSKU) UnmarshalJSON added in v1.1.0 

func (a *AccountSKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AccountSKU.

type AccountSKUAutoGenerated 

type AccountSKUAutoGenerated struct {
	// Gets or sets the sku capacity.
	Capacity *int32

	// Gets or sets the sku name.
	Name *Name
}

AccountSKUAutoGenerated - The Sku

func (AccountSKUAutoGenerated) MarshalJSON added in v1.1.0 

func (a AccountSKUAutoGenerated) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccountSKUAutoGenerated.

func (*AccountSKUAutoGenerated) UnmarshalJSON added in v1.1.0 

func (a *AccountSKUAutoGenerated) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AccountSKUAutoGenerated.

type AccountUpdateParameters 

type AccountUpdateParameters struct {
	// Identity related info to add/remove userAssignedIdentities.
	Identity *Identity

	// The account properties.
	Properties *AccountProperties

	// Tags on the azure resource.
	Tags map[string]*string
}

AccountUpdateParameters - The account update properties.

func (AccountUpdateParameters) MarshalJSON 

func (a AccountUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccountUpdateParameters.

func (*AccountUpdateParameters) UnmarshalJSON added in v1.1.0 

func (a *AccountUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AccountUpdateParameters.

type AccountsClient 

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

AccountsClient contains the methods for the Accounts group. Don't use this type directly, use NewAccountsClient() instead.

func NewAccountsClient 

func NewAccountsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AccountsClient, error)

NewAccountsClient creates a new instance of AccountsClient with the specified values.

  • subscriptionID - The subscription identifier
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*AccountsClient) AddRootCollectionAdmin 

func (client *AccountsClient) AddRootCollectionAdmin(ctx context.Context, resourceGroupName string, accountName string, collectionAdminUpdate CollectionAdminUpdate, options *AccountsClientAddRootCollectionAdminOptions) (AccountsClientAddRootCollectionAdminResponse, error)

AddRootCollectionAdmin - Add the administrator for root collection associated with this account. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-07-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the account.
  • collectionAdminUpdate - The collection admin update payload.
  • options - AccountsClientAddRootCollectionAdminOptions contains the optional parameters for the AccountsClient.AddRootCollectionAdmin method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_AddRootCollectionAdmin.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/purview/armpurview"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpurview.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewAccountsClient().AddRootCollectionAdmin(ctx, "SampleResourceGroup", "account1", armpurview.CollectionAdminUpdate{
		ObjectID: to.Ptr("7e8de0e7-2bfc-4e1f-9659-2a5785e4356f"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*AccountsClient) BeginCreateOrUpdate 

func (client *AccountsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, account Account, options *AccountsClientBeginCreateOrUpdateOptions) (*runtime.Poller[AccountsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates an account If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-07-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the account.
  • account - The account.
  • options - AccountsClientBeginCreateOrUpdateOptions contains the optional parameters for the AccountsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_CreateOrUpdate.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/purview/armpurview"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpurview.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewAccountsClient().BeginCreateOrUpdate(ctx, "SampleResourceGroup", "account1", armpurview.Account{
		Location: to.Ptr("West US 2"),
		Properties: &armpurview.AccountProperties{
			ManagedResourceGroupName: to.Ptr("custom-rgname"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armpurview.Account{
	// 	Name: to.Ptr("account1"),
	// 	Type: to.Ptr("Microsoft.Purview/accounts"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1"),
	// 	Location: to.Ptr("West US 2"),
	// 	SystemData: &armpurview.TrackedResourceSystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-22T18:39:58.692Z"); return t}()),
	// 		CreatedBy: to.Ptr("client-name"),
	// 		CreatedByType: to.Ptr(armpurview.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-16T23:24:34.343Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("client-name"),
	// 		LastModifiedByType: to.Ptr(armpurview.LastModifiedByTypeUser),
	// 	},
	// 	Properties: &armpurview.AccountProperties{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-22T18:39:58.692Z"); return t}()),
	// 		CreatedBy: to.Ptr("client-name"),
	// 		CreatedByObjectID: to.Ptr("client-objectId"),
	// 		Endpoints: &armpurview.AccountPropertiesEndpoints{
	// 			Catalog: to.Ptr("https://account1.catalog.purview.azure-test.com"),
	// 			Guardian: to.Ptr("https://account1.guardian.purview.azure-test.com"),
	// 			Scan: to.Ptr("https://account1.scan.purview.azure-test.com"),
	// 		},
	// 		FriendlyName: to.Ptr("friendly-account1"),
	// 		ManagedResourceGroupName: to.Ptr("custom-rgname"),
	// 		ManagedResources: &armpurview.AccountPropertiesManagedResources{
	// 			EventHubNamespace: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/custom-rgname/providers/Microsoft.EventHub/namespaces/atlas-westusdddnbtp"),
	// 			ResourceGroup: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/custom-rgname"),
	// 			StorageAccount: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/custom-rgname/providers/Microsoft.Storage/storageAccounts/scanwestustzaagzr"),
	// 		},
	// 		ProvisioningState: to.Ptr(armpurview.ProvisioningStateSucceeded),
	// 		PublicNetworkAccess: to.Ptr(armpurview.PublicNetworkAccessEnabled),
	// 	},
	// 	SKU: &armpurview.AccountSKU{
	// 		Name: to.Ptr(armpurview.NameStandard),
	// 		Capacity: to.Ptr[int32](1),
	// 	},
	// }
}

Output:

func (*AccountsClient) BeginDelete 

func (client *AccountsClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, options *AccountsClientBeginDeleteOptions) (*runtime.Poller[AccountsClientDeleteResponse], error)

BeginDelete - Deletes an account resource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-07-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the account.
  • options - AccountsClientBeginDeleteOptions contains the optional parameters for the AccountsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/purview/armpurview"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpurview.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewAccountsClient().BeginDelete(ctx, "SampleResourceGroup", "account1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*AccountsClient) BeginUpdate 

func (client *AccountsClient) BeginUpdate(ctx context.Context, resourceGroupName string, accountName string, accountUpdateParameters AccountUpdateParameters, options *AccountsClientBeginUpdateOptions) (*runtime.Poller[AccountsClientUpdateResponse], error)

BeginUpdate - Updates an account If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-07-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the account.
  • accountUpdateParameters - The account update parameters.
  • options - AccountsClientBeginUpdateOptions contains the optional parameters for the AccountsClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_Update.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/purview/armpurview"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpurview.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewAccountsClient().BeginUpdate(ctx, "SampleResourceGroup", "account1", armpurview.AccountUpdateParameters{
		Tags: map[string]*string{
			"newTag": to.Ptr("New tag value."),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armpurview.Account{
	// 	Name: to.Ptr("account1"),
	// 	Type: to.Ptr("Microsoft.Purview/accounts"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1"),
	// 	Location: to.Ptr("West US 2"),
	// 	SystemData: &armpurview.TrackedResourceSystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-22T18:39:58.692Z"); return t}()),
	// 		CreatedBy: to.Ptr("client-name"),
	// 		CreatedByType: to.Ptr(armpurview.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-16T23:24:34.343Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("client-name"),
	// 		LastModifiedByType: to.Ptr(armpurview.LastModifiedByTypeUser),
	// 	},
	// 	Tags: map[string]*string{
	// 		"newTag": to.Ptr("New tag value."),
	// 	},
	// 	Properties: &armpurview.AccountProperties{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-22T18:39:58.692Z"); return t}()),
	// 		CreatedBy: to.Ptr("client-name"),
	// 		CreatedByObjectID: to.Ptr("client-objectId"),
	// 		Endpoints: &armpurview.AccountPropertiesEndpoints{
	// 			Catalog: to.Ptr("https://account2.catalog.purview.azure-test.com"),
	// 			Guardian: to.Ptr("https://account1.guardian.purview.azure-test.com"),
	// 			Scan: to.Ptr("https://account2.scan.purview.azure-test.com"),
	// 		},
	// 		FriendlyName: to.Ptr("friendly-account1"),
	// 		ManagedResources: &armpurview.AccountPropertiesManagedResources{
	// 			EventHubNamespace: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.EventHub/namespaces/atlas-westusdddnbtp"),
	// 			ResourceGroup: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl"),
	// 			StorageAccount: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.Storage/storageAccounts/scanwestustzaagzr"),
	// 		},
	// 		ProvisioningState: to.Ptr(armpurview.ProvisioningStateSucceeded),
	// 		PublicNetworkAccess: to.Ptr(armpurview.PublicNetworkAccessEnabled),
	// 	},
	// 	SKU: &armpurview.AccountSKU{
	// 		Name: to.Ptr(armpurview.NameStandard),
	// 		Capacity: to.Ptr[int32](1),
	// 	},
	// }
}

Output:

func (*AccountsClient) CheckNameAvailability 

func (client *AccountsClient) CheckNameAvailability(ctx context.Context, checkNameAvailabilityRequest CheckNameAvailabilityRequest, options *AccountsClientCheckNameAvailabilityOptions) (AccountsClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - Checks if account name is available. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-07-01

  • checkNameAvailabilityRequest - The check name availability request.
  • options - AccountsClientCheckNameAvailabilityOptions contains the optional parameters for the AccountsClient.CheckNameAvailability method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_CheckNameAvailability.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/purview/armpurview"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpurview.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountsClient().CheckNameAvailability(ctx, armpurview.CheckNameAvailabilityRequest{
		Name: to.Ptr("account1"),
		Type: to.Ptr("Microsoft.Purview/accounts"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CheckNameAvailabilityResult = armpurview.CheckNameAvailabilityResult{
	// 	NameAvailable: to.Ptr(true),
	// }
}

Output:

func (*AccountsClient) Get 

func (client *AccountsClient) Get(ctx context.Context, resourceGroupName string, accountName string, options *AccountsClientGetOptions) (AccountsClientGetResponse, error)

Get - Get an account If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-07-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the account.
  • options - AccountsClientGetOptions contains the optional parameters for the AccountsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/purview/armpurview"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpurview.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountsClient().Get(ctx, "SampleResourceGroup", "account1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armpurview.Account{
	// 	Name: to.Ptr("account1"),
	// 	Type: to.Ptr("Microsoft.Purview/accounts"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1"),
	// 	Location: to.Ptr("West US 2"),
	// 	SystemData: &armpurview.TrackedResourceSystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-22T18:39:58.692Z"); return t}()),
	// 		CreatedBy: to.Ptr("client-name"),
	// 		CreatedByType: to.Ptr(armpurview.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-16T23:24:34.343Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("client-name"),
	// 		LastModifiedByType: to.Ptr(armpurview.LastModifiedByTypeUser),
	// 	},
	// 	Properties: &armpurview.AccountProperties{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-22T18:39:58.692Z"); return t}()),
	// 		CreatedBy: to.Ptr("client-name"),
	// 		CreatedByObjectID: to.Ptr("client-objectId"),
	// 		Endpoints: &armpurview.AccountPropertiesEndpoints{
	// 			Catalog: to.Ptr("https://account1.catalog.purview.azure-test.com"),
	// 			Guardian: to.Ptr("https://account1.guardian.purview.azure-test.com"),
	// 			Scan: to.Ptr("https://account1.scan.purview.azure-test.com"),
	// 		},
	// 		FriendlyName: to.Ptr("friendly-account1"),
	// 		ManagedResourceGroupName: to.Ptr("managed-rg-mwjotkl"),
	// 		ManagedResources: &armpurview.AccountPropertiesManagedResources{
	// 			EventHubNamespace: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.EventHub/namespaces/atlas-westusdddnbtp"),
	// 			ResourceGroup: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl"),
	// 			StorageAccount: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.Storage/storageAccounts/scanwestustzaagzr"),
	// 		},
	// 		PrivateEndpointConnections: []*armpurview.PrivateEndpointConnection{
	// 			{
	// 				Name: to.Ptr("peName-8536c337-7b36-4d67-a7ce-081655baf59e"),
	// 				Type: to.Ptr("Microsoft.Purview/accounts/privateEndpointConnections"),
	// 				ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/peName-8536c337-7b36-4d67-a7ce-081655baf59e"),
	// 				Properties: &armpurview.PrivateEndpointConnectionProperties{
	// 					PrivateEndpoint: &armpurview.PrivateEndpoint{
	// 						ID: to.Ptr("/subscriptions/baca8a88-4527-4c35-a13e-b2775ce0d7fc/resourceGroups/nrpResourceGroupName/providers/Microsoft.Network/privateEndpoints/peName"),
	// 					},
	// 					PrivateLinkServiceConnectionState: &armpurview.PrivateLinkServiceConnectionState{
	// 						Description: to.Ptr("Please approve my connection, thanks."),
	// 						ActionsRequired: to.Ptr("None"),
	// 						Status: to.Ptr(armpurview.StatusPending),
	// 					},
	// 					ProvisioningState: to.Ptr("Succeeded"),
	// 				},
	// 		}},
	// 		ProvisioningState: to.Ptr(armpurview.ProvisioningStateSucceeded),
	// 		PublicNetworkAccess: to.Ptr(armpurview.PublicNetworkAccessEnabled),
	// 	},
	// 	SKU: &armpurview.AccountSKU{
	// 		Name: to.Ptr(armpurview.NameStandard),
	// 		Capacity: to.Ptr[int32](1),
	// 	},
	// }
}

Output:

func (*AccountsClient) ListKeys 

func (client *AccountsClient) ListKeys(ctx context.Context, resourceGroupName string, accountName string, options *AccountsClientListKeysOptions) (AccountsClientListKeysResponse, error)

ListKeys - List the authorization keys associated with this account. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-07-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the account.
  • options - AccountsClientListKeysOptions contains the optional parameters for the AccountsClient.ListKeys method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_ListKeys.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/purview/armpurview"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpurview.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountsClient().ListKeys(ctx, "SampleResourceGroup", "account1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AccessKeys = armpurview.AccessKeys{
	// 	AtlasKafkaPrimaryEndpoint: to.Ptr("Endpoint=sb://fake_objectId.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=ASDASasdfmasdf123412341234="),
	// 	AtlasKafkaSecondaryEndpoint: to.Ptr("Endpoint=sb://fake_objectId.servicebus.windows.net/;SharedAccessKeyName=AlternateSharedAccessKey;SharedAccessKey=BSDASasdfmasdf123412341234="),
	// }
}

Output:

func (*AccountsClient) NewListByResourceGroupPager added in v0.4.0 

func (client *AccountsClient) NewListByResourceGroupPager(resourceGroupName string, options *AccountsClientListByResourceGroupOptions) *runtime.Pager[AccountsClientListByResourceGroupResponse]

NewListByResourceGroupPager - List accounts in ResourceGroup

Generated from API version 2021-07-01

  • resourceGroupName - The resource group name.
  • options - AccountsClientListByResourceGroupOptions contains the optional parameters for the AccountsClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_ListByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/purview/armpurview"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpurview.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAccountsClient().NewListByResourceGroupPager("SampleResourceGroup", &armpurview.AccountsClientListByResourceGroupOptions{SkipToken: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AccountList = armpurview.AccountList{
		// 	Value: []*armpurview.Account{
		// 		{
		// 			Name: to.Ptr("account1"),
		// 			Type: to.Ptr("Microsoft.Purview/accounts"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1"),
		// 			Location: to.Ptr("West US 2"),
		// 			SystemData: &armpurview.TrackedResourceSystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-22T18:39:58.692Z"); return t}()),
		// 				CreatedBy: to.Ptr("client-name"),
		// 				CreatedByType: to.Ptr(armpurview.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-16T23:24:34.343Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("client-name"),
		// 				LastModifiedByType: to.Ptr(armpurview.LastModifiedByTypeUser),
		// 			},
		// 			Properties: &armpurview.AccountProperties{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-22T18:39:58.692Z"); return t}()),
		// 				CreatedBy: to.Ptr("client-name"),
		// 				CreatedByObjectID: to.Ptr("client-objectId"),
		// 				Endpoints: &armpurview.AccountPropertiesEndpoints{
		// 					Catalog: to.Ptr("https://account1.catalog.purview.azure-test.com"),
		// 					Guardian: to.Ptr("https://account1.guardian.purview.azure-test.com"),
		// 					Scan: to.Ptr("https://account1.scan.purview.azure-test.com"),
		// 				},
		// 				FriendlyName: to.Ptr("friendly-account1"),
		// 				ProvisioningState: to.Ptr(armpurview.ProvisioningStateSucceeded),
		// 				PublicNetworkAccess: to.Ptr(armpurview.PublicNetworkAccessEnabled),
		// 			},
		// 			SKU: &armpurview.AccountSKU{
		// 				Name: to.Ptr(armpurview.NameStandard),
		// 				Capacity: to.Ptr[int32](1),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("account2"),
		// 			Type: to.Ptr("Microsoft.Purview/accounts"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account2"),
		// 			Location: to.Ptr("West US 2"),
		// 			SystemData: &armpurview.TrackedResourceSystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-22T18:39:58.692Z"); return t}()),
		// 				CreatedBy: to.Ptr("client-name"),
		// 				CreatedByType: to.Ptr(armpurview.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-16T23:24:34.343Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("client-name"),
		// 				LastModifiedByType: to.Ptr(armpurview.LastModifiedByTypeUser),
		// 			},
		// 			Properties: &armpurview.AccountProperties{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-22T18:39:58.692Z"); return t}()),
		// 				CreatedBy: to.Ptr("client-name"),
		// 				CreatedByObjectID: to.Ptr("client-objectId"),
		// 				Endpoints: &armpurview.AccountPropertiesEndpoints{
		// 					Catalog: to.Ptr("https://account2.catalog.purview.azure-test.com"),
		// 					Guardian: to.Ptr("https://account1.guardian.purview.azure-test.com"),
		// 					Scan: to.Ptr("https://account2.scan.purview.azure-test.com"),
		// 				},
		// 				FriendlyName: to.Ptr("friendly-account1"),
		// 				ProvisioningState: to.Ptr(armpurview.ProvisioningStateSucceeded),
		// 				PublicNetworkAccess: to.Ptr(armpurview.PublicNetworkAccessEnabled),
		// 			},
		// 			SKU: &armpurview.AccountSKU{
		// 				Name: to.Ptr(armpurview.NameStandard),
		// 				Capacity: to.Ptr[int32](1),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*AccountsClient) NewListBySubscriptionPager added in v0.4.0 

func (client *AccountsClient) NewListBySubscriptionPager(options *AccountsClientListBySubscriptionOptions) *runtime.Pager[AccountsClientListBySubscriptionResponse]

NewListBySubscriptionPager - List accounts in Subscription

Generated from API version 2021-07-01

  • options - AccountsClientListBySubscriptionOptions contains the optional parameters for the AccountsClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_ListBySubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/purview/armpurview"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpurview.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAccountsClient().NewListBySubscriptionPager(&armpurview.AccountsClientListBySubscriptionOptions{SkipToken: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AccountList = armpurview.AccountList{
		// 	Value: []*armpurview.Account{
		// 		{
		// 			Name: to.Ptr("account1"),
		// 			Type: to.Ptr("Microsoft.Purview/accounts"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1"),
		// 			Location: to.Ptr("West US 2"),
		// 			SystemData: &armpurview.TrackedResourceSystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-22T18:39:58.692Z"); return t}()),
		// 				CreatedBy: to.Ptr("client-name"),
		// 				CreatedByType: to.Ptr(armpurview.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-16T23:24:34.343Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("client-name"),
		// 				LastModifiedByType: to.Ptr(armpurview.LastModifiedByTypeUser),
		// 			},
		// 			Properties: &armpurview.AccountProperties{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-22T18:39:58.692Z"); return t}()),
		// 				CreatedBy: to.Ptr("client-name"),
		// 				CreatedByObjectID: to.Ptr("client-objectId"),
		// 				Endpoints: &armpurview.AccountPropertiesEndpoints{
		// 					Catalog: to.Ptr("https://account1.catalog.purview.azure-test.com"),
		// 					Guardian: to.Ptr("https://account1.guardian.purview.azure-test.com"),
		// 					Scan: to.Ptr("https://account1.scan.purview.azure-test.com"),
		// 				},
		// 				FriendlyName: to.Ptr("friendly-account1"),
		// 				ProvisioningState: to.Ptr(armpurview.ProvisioningStateSucceeded),
		// 				PublicNetworkAccess: to.Ptr(armpurview.PublicNetworkAccessEnabled),
		// 			},
		// 			SKU: &armpurview.AccountSKU{
		// 				Name: to.Ptr(armpurview.NameStandard),
		// 				Capacity: to.Ptr[int32](1),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("account2"),
		// 			Type: to.Ptr("Microsoft.Purview/accounts"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account2"),
		// 			Location: to.Ptr("West US 2"),
		// 			SystemData: &armpurview.TrackedResourceSystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-22T18:39:58.692Z"); return t}()),
		// 				CreatedBy: to.Ptr("client-name"),
		// 				CreatedByType: to.Ptr(armpurview.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-16T23:24:34.343Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("client-name"),
		// 				LastModifiedByType: to.Ptr(armpurview.LastModifiedByTypeUser),
		// 			},
		// 			Properties: &armpurview.AccountProperties{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-22T18:39:58.692Z"); return t}()),
		// 				CreatedBy: to.Ptr("client-name"),
		// 				CreatedByObjectID: to.Ptr("client-objectId"),
		// 				Endpoints: &armpurview.AccountPropertiesEndpoints{
		// 					Catalog: to.Ptr("https://account2.catalog.purview.azure-test.com"),
		// 					Guardian: to.Ptr("https://account1.guardian.purview.azure-test.com"),
		// 					Scan: to.Ptr("https://account2.scan.purview.azure-test.com"),
		// 				},
		// 				FriendlyName: to.Ptr("friendly-account1"),
		// 				ProvisioningState: to.Ptr(armpurview.ProvisioningStateSucceeded),
		// 				PublicNetworkAccess: to.Ptr(armpurview.PublicNetworkAccessEnabled),
		// 			},
		// 			SKU: &armpurview.AccountSKU{
		// 				Name: to.Ptr(armpurview.NameStandard),
		// 				Capacity: to.Ptr[int32](1),
		// 			},
		// 	}},
		// }
	}
}

Output:

type AccountsClientAddRootCollectionAdminOptions added in v0.2.0 

type AccountsClientAddRootCollectionAdminOptions struct {
}

AccountsClientAddRootCollectionAdminOptions contains the optional parameters for the AccountsClient.AddRootCollectionAdmin method.

type AccountsClientAddRootCollectionAdminResponse added in v0.2.0 

type AccountsClientAddRootCollectionAdminResponse struct {
}

AccountsClientAddRootCollectionAdminResponse contains the response from method AccountsClient.AddRootCollectionAdmin.

type AccountsClientBeginCreateOrUpdateOptions added in v0.2.0 

type AccountsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

AccountsClientBeginCreateOrUpdateOptions contains the optional parameters for the AccountsClient.BeginCreateOrUpdate method.

type AccountsClientBeginDeleteOptions added in v0.2.0 

type AccountsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

AccountsClientBeginDeleteOptions contains the optional parameters for the AccountsClient.BeginDelete method.

type AccountsClientBeginUpdateOptions added in v0.2.0 

type AccountsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

AccountsClientBeginUpdateOptions contains the optional parameters for the AccountsClient.BeginUpdate method.

type AccountsClientCheckNameAvailabilityOptions added in v0.2.0 

type AccountsClientCheckNameAvailabilityOptions struct {
}

AccountsClientCheckNameAvailabilityOptions contains the optional parameters for the AccountsClient.CheckNameAvailability method.

type AccountsClientCheckNameAvailabilityResponse added in v0.2.0 

type AccountsClientCheckNameAvailabilityResponse struct {
	// The response payload for CheckNameAvailability API
	CheckNameAvailabilityResult
}

AccountsClientCheckNameAvailabilityResponse contains the response from method AccountsClient.CheckNameAvailability.

type AccountsClientCreateOrUpdateResponse added in v0.2.0 

type AccountsClientCreateOrUpdateResponse struct {
	// Account resource
	Account
}

AccountsClientCreateOrUpdateResponse contains the response from method AccountsClient.BeginCreateOrUpdate.

type AccountsClientDeleteResponse added in v0.2.0 

type AccountsClientDeleteResponse struct {
}

AccountsClientDeleteResponse contains the response from method AccountsClient.BeginDelete.

type AccountsClientGetOptions added in v0.2.0 

type AccountsClientGetOptions struct {
}

AccountsClientGetOptions contains the optional parameters for the AccountsClient.Get method.

type AccountsClientGetResponse added in v0.2.0 

type AccountsClientGetResponse struct {
	// Account resource
	Account
}

AccountsClientGetResponse contains the response from method AccountsClient.Get.

type AccountsClientListByResourceGroupOptions added in v0.2.0 

type AccountsClientListByResourceGroupOptions struct {
	// The skip token.
	SkipToken *string
}

AccountsClientListByResourceGroupOptions contains the optional parameters for the AccountsClient.NewListByResourceGroupPager method.

type AccountsClientListByResourceGroupResponse added in v0.2.0 

type AccountsClientListByResourceGroupResponse struct {
	// Paged list of account resources
	AccountList
}

AccountsClientListByResourceGroupResponse contains the response from method AccountsClient.NewListByResourceGroupPager.

type AccountsClientListBySubscriptionOptions added in v0.2.0 

type AccountsClientListBySubscriptionOptions struct {
	// The skip token.
	SkipToken *string
}

AccountsClientListBySubscriptionOptions contains the optional parameters for the AccountsClient.NewListBySubscriptionPager method.

type AccountsClientListBySubscriptionResponse added in v0.2.0 

type AccountsClientListBySubscriptionResponse struct {
	// Paged list of account resources
	AccountList
}

AccountsClientListBySubscriptionResponse contains the response from method AccountsClient.NewListBySubscriptionPager.

type AccountsClientListKeysOptions added in v0.2.0 

type AccountsClientListKeysOptions struct {
}

AccountsClientListKeysOptions contains the optional parameters for the AccountsClient.ListKeys method.

type AccountsClientListKeysResponse added in v0.2.0 

type AccountsClientListKeysResponse struct {
	// The Account access keys.
	AccessKeys
}

AccountsClientListKeysResponse contains the response from method AccountsClient.ListKeys.

type AccountsClientUpdateResponse added in v0.2.0 

type AccountsClientUpdateResponse struct {
	// Account resource
	Account
}

AccountsClientUpdateResponse contains the response from method AccountsClient.BeginUpdate.

type CheckNameAvailabilityRequest 

type CheckNameAvailabilityRequest struct {
	// Resource name to verify for availability
	Name *string

	// Fully qualified resource type which includes provider namespace
	Type *string
}

CheckNameAvailabilityRequest - The request payload for CheckNameAvailability API

func (CheckNameAvailabilityRequest) MarshalJSON added in v1.1.0 

func (c CheckNameAvailabilityRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CheckNameAvailabilityRequest.

func (*CheckNameAvailabilityRequest) UnmarshalJSON added in v1.1.0 

func (c *CheckNameAvailabilityRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CheckNameAvailabilityRequest.

type CheckNameAvailabilityResult 

type CheckNameAvailabilityResult struct {
	// Error message
	Message *string

	// Indicates if name is valid and available.
	NameAvailable *bool

	// The reason the name is not available.
	Reason *Reason
}

CheckNameAvailabilityResult - The response payload for CheckNameAvailability API

func (CheckNameAvailabilityResult) MarshalJSON added in v1.1.0 

func (c CheckNameAvailabilityResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CheckNameAvailabilityResult.

func (*CheckNameAvailabilityResult) UnmarshalJSON added in v1.1.0 

func (c *CheckNameAvailabilityResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CheckNameAvailabilityResult.

type ClientFactory added in v1.1.0 

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

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory added in v1.1.0 

func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • subscriptionID - The subscription identifier
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewAccountsClient added in v1.1.0 

func (c *ClientFactory) NewAccountsClient() *AccountsClient

NewAccountsClient creates a new instance of AccountsClient.

func (*ClientFactory) NewDefaultAccountsClient added in v1.1.0 

func (c *ClientFactory) NewDefaultAccountsClient() *DefaultAccountsClient

NewDefaultAccountsClient creates a new instance of DefaultAccountsClient.

func (*ClientFactory) NewOperationsClient added in v1.1.0 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewPrivateEndpointConnectionsClient added in v1.1.0 

func (c *ClientFactory) NewPrivateEndpointConnectionsClient() *PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient.

func (*ClientFactory) NewPrivateLinkResourcesClient added in v1.1.0 

func (c *ClientFactory) NewPrivateLinkResourcesClient() *PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient.

type CloudConnectors 

type CloudConnectors struct {
	// READ-ONLY; AWS external identifier. Configured in AWS to allow use of the role arn used for scanning
	AwsExternalID *string
}

CloudConnectors - External Cloud Service connectors

func (CloudConnectors) MarshalJSON added in v1.1.0 

func (c CloudConnectors) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CloudConnectors.

func (*CloudConnectors) UnmarshalJSON added in v1.1.0 

func (c *CloudConnectors) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CloudConnectors.

type CollectionAdminUpdate 

type CollectionAdminUpdate struct {
	// Gets or sets the object identifier of the admin.
	ObjectID *string
}

CollectionAdminUpdate - Collection administrator update.

func (CollectionAdminUpdate) MarshalJSON added in v1.1.0 

func (c CollectionAdminUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CollectionAdminUpdate.

func (*CollectionAdminUpdate) UnmarshalJSON added in v1.1.0 

func (c *CollectionAdminUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CollectionAdminUpdate.

type CreatedByType 

type CreatedByType string

CreatedByType - The type of identity that created the resource. 

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

type DefaultAccountPayload 

type DefaultAccountPayload struct {
	// The name of the account that is set as the default.
	AccountName *string

	// The resource group name of the account that is set as the default.
	ResourceGroupName *string

	// The scope object ID. For example, sub ID or tenant ID.
	Scope *string

	// The scope tenant in which the default account is set.
	ScopeTenantID *string

	// The scope where the default account is set.
	ScopeType *ScopeType

	// The subscription ID of the account that is set as the default.
	SubscriptionID *string
}

DefaultAccountPayload - Payload to get and set the default account in the given scope

func (DefaultAccountPayload) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type DefaultAccountPayload.

func (*DefaultAccountPayload) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultAccountPayload.

type DefaultAccountsClient 

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

DefaultAccountsClient contains the methods for the DefaultAccounts group. Don't use this type directly, use NewDefaultAccountsClient() instead.

func NewDefaultAccountsClient 

func NewDefaultAccountsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*DefaultAccountsClient, error)

NewDefaultAccountsClient creates a new instance of DefaultAccountsClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*DefaultAccountsClient) Get 

func (client *DefaultAccountsClient) Get(ctx context.Context, scopeTenantID string, scopeType ScopeType, options *DefaultAccountsClientGetOptions) (DefaultAccountsClientGetResponse, error)

Get - Get the default account for the scope. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-07-01

  • scopeTenantID - The tenant ID.
  • scopeType - The scope for the default account.
  • options - DefaultAccountsClientGetOptions contains the optional parameters for the DefaultAccountsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/DefaultAccounts_Get.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/purview/armpurview"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpurview.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDefaultAccountsClient().Get(ctx, "11733A4E-BA84-46FF-91D1-AFF1A3215A90", armpurview.ScopeTypeTenant, &armpurview.DefaultAccountsClientGetOptions{Scope: to.Ptr("11733A4E-BA84-46FF-91D1-AFF1A3215A90")})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DefaultAccountPayload = armpurview.DefaultAccountPayload{
	// 	AccountName: to.Ptr("myDefaultAccount"),
	// 	ResourceGroupName: to.Ptr("rg-1"),
	// 	Scope: to.Ptr("11733A4E-BA84-46FF-91D1-AFF1A3215A90"),
	// 	ScopeTenantID: to.Ptr("11733A4E-BA84-46FF-91D1-AFF1A3215A90"),
	// 	ScopeType: to.Ptr(armpurview.ScopeTypeTenant),
	// 	SubscriptionID: to.Ptr("12345678-1234-1234-12345678aaa"),
	// }
}

Output:

func (*DefaultAccountsClient) Remove 

func (client *DefaultAccountsClient) Remove(ctx context.Context, scopeTenantID string, scopeType ScopeType, options *DefaultAccountsClientRemoveOptions) (DefaultAccountsClientRemoveResponse, error)

Remove - Removes the default account from the scope. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-07-01

  • scopeTenantID - The tenant ID.
  • scopeType - The scope for the default account.
  • options - DefaultAccountsClientRemoveOptions contains the optional parameters for the DefaultAccountsClient.Remove method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/DefaultAccounts_Remove.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/purview/armpurview"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpurview.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewDefaultAccountsClient().Remove(ctx, "11733A4E-BA84-46FF-91D1-AFF1A3215A90", armpurview.ScopeTypeTenant, &armpurview.DefaultAccountsClientRemoveOptions{Scope: to.Ptr("11733A4E-BA84-46FF-91D1-AFF1A3215A90")})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

Output:

func (*DefaultAccountsClient) Set 

func (client *DefaultAccountsClient) Set(ctx context.Context, defaultAccountPayload DefaultAccountPayload, options *DefaultAccountsClientSetOptions) (DefaultAccountsClientSetResponse, error)

Set - Sets the default account for the scope. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-07-01

  • defaultAccountPayload - The payload containing the default account information and the scope.
  • options - DefaultAccountsClientSetOptions contains the optional parameters for the DefaultAccountsClient.Set method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/DefaultAccounts_Set.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/purview/armpurview"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpurview.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDefaultAccountsClient().Set(ctx, armpurview.DefaultAccountPayload{
		AccountName:       to.Ptr("myDefaultAccount"),
		ResourceGroupName: to.Ptr("rg-1"),
		Scope:             to.Ptr("11733A4E-BA84-46FF-91D1-AFF1A3215A90"),
		ScopeTenantID:     to.Ptr("11733A4E-BA84-46FF-91D1-AFF1A3215A90"),
		ScopeType:         to.Ptr(armpurview.ScopeTypeTenant),
		SubscriptionID:    to.Ptr("12345678-1234-1234-12345678aaa"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DefaultAccountPayload = armpurview.DefaultAccountPayload{
	// 	AccountName: to.Ptr("myDefaultAccount"),
	// 	ResourceGroupName: to.Ptr("rg-1"),
	// 	Scope: to.Ptr("11733A4E-BA84-46FF-91D1-AFF1A3215A90"),
	// 	ScopeTenantID: to.Ptr("11733A4E-BA84-46FF-91D1-AFF1A3215A90"),
	// 	ScopeType: to.Ptr(armpurview.ScopeTypeTenant),
	// 	SubscriptionID: to.Ptr("12345678-1234-1234-12345678aaa"),
	// }
}

Output:

type DefaultAccountsClientGetOptions added in v0.2.0 

type DefaultAccountsClientGetOptions struct {
	// The Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription.
	Scope *string
}

DefaultAccountsClientGetOptions contains the optional parameters for the DefaultAccountsClient.Get method.

type DefaultAccountsClientGetResponse added in v0.2.0 

type DefaultAccountsClientGetResponse struct {
	// Payload to get and set the default account in the given scope
	DefaultAccountPayload
}

DefaultAccountsClientGetResponse contains the response from method DefaultAccountsClient.Get.

type DefaultAccountsClientRemoveOptions added in v0.2.0 

type DefaultAccountsClientRemoveOptions struct {
	// The Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription.
	Scope *string
}

DefaultAccountsClientRemoveOptions contains the optional parameters for the DefaultAccountsClient.Remove method.

type DefaultAccountsClientRemoveResponse added in v0.2.0 

type DefaultAccountsClientRemoveResponse struct {
}

DefaultAccountsClientRemoveResponse contains the response from method DefaultAccountsClient.Remove.

type DefaultAccountsClientSetOptions added in v0.2.0 

type DefaultAccountsClientSetOptions struct {
}

DefaultAccountsClientSetOptions contains the optional parameters for the DefaultAccountsClient.Set method.

type DefaultAccountsClientSetResponse added in v0.2.0 

type DefaultAccountsClientSetResponse struct {
	// Payload to get and set the default account in the given scope
	DefaultAccountPayload
}

DefaultAccountsClientSetResponse contains the response from method DefaultAccountsClient.Set.

type DimensionProperties 

type DimensionProperties struct {
	// localized display name of the dimension to customer
	DisplayName *string

	// dimension name
	Name *string

	// flag indicating whether this dimension should be included to the customer in Azure Monitor logs (aka Shoebox)
	ToBeExportedForCustomer *bool
}

DimensionProperties - properties for dimension

func (DimensionProperties) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type DimensionProperties.

func (*DimensionProperties) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DimensionProperties.

type ErrorModel 

type ErrorModel struct {
	// READ-ONLY; Gets or sets the code.
	Code *string

	// READ-ONLY; Gets or sets the details.
	Details []*ErrorModel

	// READ-ONLY; Gets or sets the messages.
	Message *string

	// READ-ONLY; Gets or sets the target.
	Target *string
}

ErrorModel - Default error model

func (ErrorModel) MarshalJSON 

func (e ErrorModel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorModel.

func (*ErrorModel) UnmarshalJSON added in v1.1.0 

func (e *ErrorModel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorModel.

type ErrorResponseModel 

type ErrorResponseModel struct {
	// READ-ONLY; Gets or sets the error.
	Error *ErrorResponseModelError
}

ErrorResponseModel - Default error response model

func (ErrorResponseModel) MarshalJSON added in v1.1.0 

func (e ErrorResponseModel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorResponseModel.

func (*ErrorResponseModel) UnmarshalJSON added in v1.1.0 

func (e *ErrorResponseModel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponseModel.

type ErrorResponseModelError 

type ErrorResponseModelError struct {
	// READ-ONLY; Gets or sets the code.
	Code *string

	// READ-ONLY; Gets or sets the details.
	Details []*ErrorModel

	// READ-ONLY; Gets or sets the messages.
	Message *string

	// READ-ONLY; Gets or sets the target.
	Target *string
}

ErrorResponseModelError - Gets or sets the error.

func (ErrorResponseModelError) MarshalJSON added in v0.2.0 

func (e ErrorResponseModelError) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorResponseModelError.

func (*ErrorResponseModelError) UnmarshalJSON added in v1.1.0 

func (e *ErrorResponseModelError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponseModelError.

type Identity 

type Identity struct {
	// Identity Type
	Type *Type

	// User Assigned Identities
	UserAssignedIdentities map[string]*UserAssignedIdentity

	// READ-ONLY; Service principal object Id
	PrincipalID *string

	// READ-ONLY; Tenant Id
	TenantID *string
}

Identity - The Managed Identity of the resource

func (Identity) MarshalJSON added in v0.2.0 

func (i Identity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Identity.

func (*Identity) UnmarshalJSON added in v1.1.0 

func (i *Identity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Identity.

type LastModifiedByType 

type LastModifiedByType string

LastModifiedByType - The type of identity that last modified the resource. 

const (
	LastModifiedByTypeApplication     LastModifiedByType = "Application"
	LastModifiedByTypeKey             LastModifiedByType = "Key"
	LastModifiedByTypeManagedIdentity LastModifiedByType = "ManagedIdentity"
	LastModifiedByTypeUser            LastModifiedByType = "User"
)

func PossibleLastModifiedByTypeValues 

func PossibleLastModifiedByTypeValues() []LastModifiedByType

PossibleLastModifiedByTypeValues returns the possible values for the LastModifiedByType const type.

type ManagedResources 

type ManagedResources struct {
	// READ-ONLY; Gets the managed event hub namespace resource identifier.
	EventHubNamespace *string

	// READ-ONLY; Gets the managed resource group resource identifier. This resource group will host resource dependencies for
	// the account.
	ResourceGroup *string

	// READ-ONLY; Gets the managed storage account resource identifier.
	StorageAccount *string
}

ManagedResources - The managed resources in customer subscription.

func (ManagedResources) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type ManagedResources.

func (*ManagedResources) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedResources.

type Name 

type Name string

Name - Gets or sets the sku name. 

const (
	NameStandard Name = "Standard"
)

func PossibleNameValues 

func PossibleNameValues() []Name

PossibleNameValues returns the possible values for the Name const type.

type Operation 

type Operation struct {
	// Properties on the operation
	Display *OperationDisplay

	// Whether operation is a data action
	IsDataAction *bool

	// Operation name for display purposes
	Name *string

	// origin of the operation
	Origin *string

	// properties for the operation meta info
	Properties *OperationProperties
}

Operation resource

func (Operation) MarshalJSON added in v1.1.0 

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Operation.

func (*Operation) UnmarshalJSON added in v1.1.0 

func (o *Operation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Operation.

type OperationDisplay 

type OperationDisplay struct {
	// Description of the operation for display purposes
	Description *string

	// Name of the operation for display purposes
	Operation *string

	// Name of the provider for display purposes
	Provider *string

	// Name of the resource type for display purposes
	Resource *string
}

OperationDisplay - The response model for get operation properties

func (OperationDisplay) MarshalJSON added in v1.1.0 

func (o OperationDisplay) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationDisplay.

func (*OperationDisplay) UnmarshalJSON added in v1.1.0 

func (o *OperationDisplay) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDisplay.

type OperationList 

type OperationList struct {
	// REQUIRED; Collection of items of type results.
	Value []*Operation

	// Total item count.
	Count *int64

	// The Url of next result page.
	NextLink *string
}

OperationList - Paged list of operation resources

func (OperationList) MarshalJSON 

func (o OperationList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationList.

func (*OperationList) UnmarshalJSON added in v1.1.0 

func (o *OperationList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationList.

type OperationMetaLogSpecification 

type OperationMetaLogSpecification struct {
	// blob duration of the log
	BlobDuration *string

	// localized name of the log category
	DisplayName *string

	// name of the log category
	Name *string
}

OperationMetaLogSpecification - log specifications for operation api

func (OperationMetaLogSpecification) MarshalJSON added in v1.1.0 

func (o OperationMetaLogSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationMetaLogSpecification.

func (*OperationMetaLogSpecification) UnmarshalJSON added in v1.1.0 

func (o *OperationMetaLogSpecification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationMetaLogSpecification.

type OperationMetaMetricSpecification 

type OperationMetaMetricSpecification struct {
	// aggregation type of metric
	AggregationType *string

	// properties for dimension
	Dimensions []*DimensionProperties

	// description of the metric
	DisplayDescription *string

	// localized name of the metric
	DisplayName *string

	// enable regional mdm account
	EnableRegionalMdmAccount *string

	// internal metric name
	InternalMetricName *string

	// name of the metric
	Name *string

	// dimension name use to replace resource id if specified
	ResourceIDDimensionNameOverride *string

	// Metric namespace. Only set the namespace if different from the default value, leaving it empty makes it use the value from
	// the ARM manifest.
	SourceMdmNamespace *string

	// supported aggregation types
	SupportedAggregationTypes []*string

	// supported time grain types
	SupportedTimeGrainTypes []*string

	// units for the metric
	Unit *string
}

OperationMetaMetricSpecification - metric specifications for the operation

func (OperationMetaMetricSpecification) MarshalJSON 

func (o OperationMetaMetricSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationMetaMetricSpecification.

func (*OperationMetaMetricSpecification) UnmarshalJSON added in v1.1.0 

func (o *OperationMetaMetricSpecification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationMetaMetricSpecification.

type OperationMetaServiceSpecification 

type OperationMetaServiceSpecification struct {
	// log specifications for the operation
	LogSpecifications []*OperationMetaLogSpecification

	// metric specifications for the operation
	MetricSpecifications []*OperationMetaMetricSpecification
}

OperationMetaServiceSpecification - The operation meta service specification

func (OperationMetaServiceSpecification) MarshalJSON 

func (o OperationMetaServiceSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationMetaServiceSpecification.

func (*OperationMetaServiceSpecification) UnmarshalJSON added in v1.1.0 

func (o *OperationMetaServiceSpecification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationMetaServiceSpecification.

type OperationProperties 

type OperationProperties struct {
	// meta service specification
	ServiceSpecification *OperationMetaServiceSpecification
}

OperationProperties - properties on meta info

func (OperationProperties) MarshalJSON added in v1.1.0 

func (o OperationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationProperties.

func (*OperationProperties) UnmarshalJSON added in v1.1.0 

func (o *OperationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationProperties.

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 - List of available operations

Generated from API version 2021-07-01

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Operations_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/purview/armpurview"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpurview.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewOperationsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.OperationList = armpurview.OperationList{
		// 	Value: []*armpurview.Operation{
		// 		{
		// 			Name: to.Ptr("Microsoft.Purview/operations/read"),
		// 			Display: &armpurview.OperationDisplay{
		// 				Description: to.Ptr("Reads all available operations in Purview Resource Provider."),
		// 				Operation: to.Ptr("Read all operations"),
		// 				Provider: to.Ptr("Microsoft Purview"),
		// 				Resource: to.Ptr("Operations"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Purview/register/action"),
		// 			Display: &armpurview.OperationDisplay{
		// 				Description: to.Ptr("Register the subscription for Purview Resource Provider"),
		// 				Operation: to.Ptr("Register Purview Resource Provider"),
		// 				Provider: to.Ptr("Microsoft Purview"),
		// 				Resource: to.Ptr("Purview Resource Provider"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Purview/unregister/action"),
		// 			Display: &armpurview.OperationDisplay{
		// 				Description: to.Ptr("Unregister  the subscription for Purview Resource Provider"),
		// 				Operation: to.Ptr("Unregister Purview Resource Provider"),
		// 				Provider: to.Ptr("Microsoft Purview"),
		// 				Resource: to.Ptr("Purview Resource Provider"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Purview/accounts/read"),
		// 			Display: &armpurview.OperationDisplay{
		// 				Description: to.Ptr("Read account resource for Purview Resource Provider."),
		// 				Operation: to.Ptr("Read account resource"),
		// 				Provider: to.Ptr("Microsoft Purview"),
		// 				Resource: to.Ptr("Account"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Purview/accounts/write"),
		// 			Display: &armpurview.OperationDisplay{
		// 				Description: to.Ptr("Write account resource for Purview Resource Provider."),
		// 				Operation: to.Ptr("Write account resource"),
		// 				Provider: to.Ptr("Microsoft Purview"),
		// 				Resource: to.Ptr("Account"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Purview/accounts/delete"),
		// 			Display: &armpurview.OperationDisplay{
		// 				Description: to.Ptr("Delete account resource for Purview Resource Provider."),
		// 				Operation: to.Ptr("Delete account resource"),
		// 				Provider: to.Ptr("Microsoft Purview"),
		// 				Resource: to.Ptr("Account"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type OperationsClientListOptions added in v0.2.0 

type OperationsClientListOptions struct {
}

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

type OperationsClientListResponse added in v0.2.0 

type OperationsClientListResponse struct {
	// Paged list of operation resources
	OperationList
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager.

type PrivateEndpoint 

type PrivateEndpoint struct {
	// The private endpoint identifier.
	ID *string
}

PrivateEndpoint - A private endpoint class.

func (PrivateEndpoint) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type PrivateEndpoint.

func (*PrivateEndpoint) UnmarshalJSON added in v1.1.0 

func (p *PrivateEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpoint.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	// The connection identifier.
	Properties *PrivateEndpointConnectionProperties

	// READ-ONLY; Gets or sets the identifier.
	ID *string

	// READ-ONLY; Gets or sets the name.
	Name *string

	// READ-ONLY; Gets or sets the type.
	Type *string
}

PrivateEndpointConnection - A private endpoint connection class.

func (PrivateEndpointConnection) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnection.

func (*PrivateEndpointConnection) UnmarshalJSON added in v1.1.0 

func (p *PrivateEndpointConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnection.

type PrivateEndpointConnectionList 

type PrivateEndpointConnectionList struct {
	// REQUIRED; Collection of items of type results.
	Value []*PrivateEndpointConnection

	// Total item count.
	Count *int64

	// The Url of next result page.
	NextLink *string
}

PrivateEndpointConnectionList - Paged list of private endpoint connections

func (PrivateEndpointConnectionList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionList.

func (*PrivateEndpointConnectionList) UnmarshalJSON added in v1.1.0 

func (p *PrivateEndpointConnectionList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionList.

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// The private endpoint information.
	PrivateEndpoint *PrivateEndpoint

	// The private link service connection state.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState

	// READ-ONLY; The provisioning state.
	ProvisioningState *string
}

PrivateEndpointConnectionProperties - A private endpoint connection properties class.

func (PrivateEndpointConnectionProperties) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionProperties.

func (*PrivateEndpointConnectionProperties) UnmarshalJSON added in v1.1.0 

func (p *PrivateEndpointConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionProperties.

type PrivateEndpointConnectionsClient 

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

PrivateEndpointConnectionsClient contains the methods for the PrivateEndpointConnections group. Don't use this type directly, use NewPrivateEndpointConnectionsClient() instead.

func NewPrivateEndpointConnectionsClient 

func NewPrivateEndpointConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateEndpointConnectionsClient, error)

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient with the specified values.

  • subscriptionID - The subscription identifier
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PrivateEndpointConnectionsClient) BeginCreateOrUpdate 

func (client *PrivateEndpointConnectionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string, request PrivateEndpointConnection, options *PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions) (*runtime.Poller[PrivateEndpointConnectionsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update a private endpoint connection If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-07-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the account.
  • privateEndpointConnectionName - Name of the private endpoint connection.
  • request - The request.
  • options - PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateEndpointConnections_CreateOrUpdate.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/purview/armpurview"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpurview.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewPrivateEndpointConnectionsClient().BeginCreateOrUpdate(ctx, "SampleResourceGroup", "account1", "privateEndpointConnection1", armpurview.PrivateEndpointConnection{
		Properties: &armpurview.PrivateEndpointConnectionProperties{
			PrivateLinkServiceConnectionState: &armpurview.PrivateLinkServiceConnectionState{
				Description: to.Ptr("Approved by johndoe@company.com"),
				Status:      to.Ptr(armpurview.StatusApproved),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PrivateEndpointConnection = armpurview.PrivateEndpointConnection{
	// 	Name: to.Ptr("privateEndpointConnection1"),
	// 	Type: to.Ptr("Microsoft.Purview/accounts/privateEndpointConnections"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/privateEndpointConnection1"),
	// 	Properties: &armpurview.PrivateEndpointConnectionProperties{
	// 		PrivateEndpoint: &armpurview.PrivateEndpoint{
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"),
	// 		},
	// 		PrivateLinkServiceConnectionState: &armpurview.PrivateLinkServiceConnectionState{
	// 			Description: to.Ptr("Approved by johndoe@company.com"),
	// 			Status: to.Ptr(armpurview.StatusApproved),
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 	},
	// }
}

Output:

func (*PrivateEndpointConnectionsClient) BeginDelete 

func (client *PrivateEndpointConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientBeginDeleteOptions) (*runtime.Poller[PrivateEndpointConnectionsClientDeleteResponse], error)

BeginDelete - Delete a private endpoint connection If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-07-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the account.
  • privateEndpointConnectionName - Name of the private endpoint connection.
  • options - PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateEndpointConnections_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/purview/armpurview"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpurview.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewPrivateEndpointConnectionsClient().BeginDelete(ctx, "SampleResourceGroup", "account1", "privateEndpointConnection1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*PrivateEndpointConnectionsClient) Get 

func (client *PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientGetOptions) (PrivateEndpointConnectionsClientGetResponse, error)

Get - Get a private endpoint connection If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-07-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the account.
  • privateEndpointConnectionName - Name of the private endpoint connection.
  • options - PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateEndpointConnections_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/purview/armpurview"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpurview.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPrivateEndpointConnectionsClient().Get(ctx, "SampleResourceGroup", "account1", "privateEndpointConnection1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PrivateEndpointConnection = armpurview.PrivateEndpointConnection{
	// 	Name: to.Ptr("privateEndpointConnection1"),
	// 	Type: to.Ptr("Microsoft.Purview/accounts/privateEndpointConnections"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/privateEndpointConnection1"),
	// 	Properties: &armpurview.PrivateEndpointConnectionProperties{
	// 		PrivateEndpoint: &armpurview.PrivateEndpoint{
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"),
	// 		},
	// 		PrivateLinkServiceConnectionState: &armpurview.PrivateLinkServiceConnectionState{
	// 			Description: to.Ptr("Approved by johndoe@company.com"),
	// 			Status: to.Ptr(armpurview.StatusApproved),
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 	},
	// }
}

Output:

func (*PrivateEndpointConnectionsClient) NewListByAccountPager added in v0.4.0 

func (client *PrivateEndpointConnectionsClient) NewListByAccountPager(resourceGroupName string, accountName string, options *PrivateEndpointConnectionsClientListByAccountOptions) *runtime.Pager[PrivateEndpointConnectionsClientListByAccountResponse]

NewListByAccountPager - Get private endpoint connections for account

Generated from API version 2021-07-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the account.
  • options - PrivateEndpointConnectionsClientListByAccountOptions contains the optional parameters for the PrivateEndpointConnectionsClient.NewListByAccountPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateEndpointConnections_ListByAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/purview/armpurview"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpurview.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPrivateEndpointConnectionsClient().NewListByAccountPager("SampleResourceGroup", "account1", &armpurview.PrivateEndpointConnectionsClientListByAccountOptions{SkipToken: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.PrivateEndpointConnectionList = armpurview.PrivateEndpointConnectionList{
		// 	Value: []*armpurview.PrivateEndpointConnection{
		// 		{
		// 			Name: to.Ptr("privateEndpointConnection1"),
		// 			Type: to.Ptr("Microsoft.Purview/accounts/privateEndpointConnections"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/privateEndpointConnection1"),
		// 			Properties: &armpurview.PrivateEndpointConnectionProperties{
		// 				PrivateEndpoint: &armpurview.PrivateEndpoint{
		// 					ID: to.Ptr("/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint1"),
		// 				},
		// 				PrivateLinkServiceConnectionState: &armpurview.PrivateLinkServiceConnectionState{
		// 					Description: to.Ptr("Approved by johndoe@company.com"),
		// 					Status: to.Ptr(armpurview.StatusApproved),
		// 				},
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("privateEndpointConnection2"),
		// 			Type: to.Ptr("Microsoft.Purview/accounts/privateEndpointConnections"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/privateEndpointConnection2"),
		// 			Properties: &armpurview.PrivateEndpointConnectionProperties{
		// 				PrivateEndpoint: &armpurview.PrivateEndpoint{
		// 					ID: to.Ptr("/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"),
		// 				},
		// 				PrivateLinkServiceConnectionState: &armpurview.PrivateLinkServiceConnectionState{
		// 					Description: to.Ptr("Rejected by johndoe@company.com"),
		// 					Status: to.Ptr(armpurview.StatusRejected),
		// 				},
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 			},
		// 	}},
		// }
	}
}

Output:

type PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions added in v0.2.0 

type PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PrivateEndpointConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginCreateOrUpdate method.

type PrivateEndpointConnectionsClientBeginDeleteOptions added in v0.2.0 

type PrivateEndpointConnectionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.

type PrivateEndpointConnectionsClientCreateOrUpdateResponse added in v0.2.0 

type PrivateEndpointConnectionsClientCreateOrUpdateResponse struct {
	// A private endpoint connection class.
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientCreateOrUpdateResponse contains the response from method PrivateEndpointConnectionsClient.BeginCreateOrUpdate.

type PrivateEndpointConnectionsClientDeleteResponse added in v0.2.0 

type PrivateEndpointConnectionsClientDeleteResponse struct {
}

PrivateEndpointConnectionsClientDeleteResponse contains the response from method PrivateEndpointConnectionsClient.BeginDelete.

type PrivateEndpointConnectionsClientGetOptions added in v0.2.0 

type PrivateEndpointConnectionsClientGetOptions struct {
}

PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

type PrivateEndpointConnectionsClientGetResponse added in v0.2.0 

type PrivateEndpointConnectionsClientGetResponse struct {
	// A private endpoint connection class.
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientGetResponse contains the response from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientListByAccountOptions added in v0.2.0 

type PrivateEndpointConnectionsClientListByAccountOptions struct {
	// The skip token.
	SkipToken *string
}

PrivateEndpointConnectionsClientListByAccountOptions contains the optional parameters for the PrivateEndpointConnectionsClient.NewListByAccountPager method.

type PrivateEndpointConnectionsClientListByAccountResponse added in v0.2.0 

type PrivateEndpointConnectionsClientListByAccountResponse struct {
	// Paged list of private endpoint connections
	PrivateEndpointConnectionList
}

PrivateEndpointConnectionsClientListByAccountResponse contains the response from method PrivateEndpointConnectionsClient.NewListByAccountPager.

type PrivateLinkResource 

type PrivateLinkResource struct {
	// READ-ONLY; The private link resource identifier.
	ID *string

	// READ-ONLY; The private link resource name.
	Name *string

	// READ-ONLY; The private link resource properties.
	Properties *PrivateLinkResourceProperties

	// READ-ONLY; The private link resource type.
	Type *string
}

PrivateLinkResource - A privately linkable resource.

func (PrivateLinkResource) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResource.

func (*PrivateLinkResource) UnmarshalJSON added in v1.1.0 

func (p *PrivateLinkResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResource.

type PrivateLinkResourceList 

type PrivateLinkResourceList struct {
	// REQUIRED; Collection of items of type results.
	Value []*PrivateLinkResource

	// Total item count.
	Count *int64

	// The Url of next result page.
	NextLink *string
}

PrivateLinkResourceList - Paged list of private link resources

func (PrivateLinkResourceList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceList.

func (*PrivateLinkResourceList) UnmarshalJSON added in v1.1.0 

func (p *PrivateLinkResourceList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResourceList.

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	// READ-ONLY; The private link resource group identifier.
	GroupID *string

	// READ-ONLY; This translates to how many Private IPs should be created for each privately linkable resource.
	RequiredMembers []*string

	// READ-ONLY; The required zone names for private link resource.
	RequiredZoneNames []*string
}

PrivateLinkResourceProperties - A privately linkable resource properties.

func (PrivateLinkResourceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceProperties.

func (*PrivateLinkResourceProperties) UnmarshalJSON added in v1.1.0 

func (p *PrivateLinkResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResourceProperties.

type PrivateLinkResourcesClient 

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

PrivateLinkResourcesClient contains the methods for the PrivateLinkResources group. Don't use this type directly, use NewPrivateLinkResourcesClient() instead.

func NewPrivateLinkResourcesClient 

func NewPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateLinkResourcesClient, error)

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient with the specified values.

  • subscriptionID - The subscription identifier
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PrivateLinkResourcesClient) GetByGroupID 

func (client *PrivateLinkResourcesClient) GetByGroupID(ctx context.Context, resourceGroupName string, accountName string, groupID string, options *PrivateLinkResourcesClientGetByGroupIDOptions) (PrivateLinkResourcesClientGetByGroupIDResponse, error)

GetByGroupID - Gets a privately linkable resources for an account with given group identifier If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-07-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the account.
  • groupID - The group identifier.
  • options - PrivateLinkResourcesClientGetByGroupIDOptions contains the optional parameters for the PrivateLinkResourcesClient.GetByGroupID method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateLinkResources_GetByGroupId.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/purview/armpurview"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpurview.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPrivateLinkResourcesClient().GetByGroupID(ctx, "SampleResourceGroup", "account1", "group1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PrivateLinkResource = armpurview.PrivateLinkResource{
	// 	Name: to.Ptr("plr1"),
	// 	Type: to.Ptr("Microsoft.Purview/accounts/privateLinkResources"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateLinkResources/plr1"),
	// 	Properties: &armpurview.PrivateLinkResourceProperties{
	// 		GroupID: to.Ptr("group1"),
	// 		RequiredMembers: []*string{
	// 			to.Ptr("group1")},
	// 			RequiredZoneNames: []*string{
	// 				to.Ptr("privatelinkzone1.service.azure.com")},
	// 			},
	// 		}
}

Output:

func (*PrivateLinkResourcesClient) NewListByAccountPager added in v0.4.0 

func (client *PrivateLinkResourcesClient) NewListByAccountPager(resourceGroupName string, accountName string, options *PrivateLinkResourcesClientListByAccountOptions) *runtime.Pager[PrivateLinkResourcesClientListByAccountResponse]

NewListByAccountPager - Gets a list of privately linkable resources for an account

Generated from API version 2021-07-01

  • resourceGroupName - The resource group name.
  • accountName - The name of the account.
  • options - PrivateLinkResourcesClientListByAccountOptions contains the optional parameters for the PrivateLinkResourcesClient.NewListByAccountPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateLinkResources_ListByAccount.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/purview/armpurview"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpurview.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPrivateLinkResourcesClient().NewListByAccountPager("SampleResourceGroup", "account1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.PrivateLinkResourceList = armpurview.PrivateLinkResourceList{
		// 	Value: []*armpurview.PrivateLinkResource{
		// 		{
		// 			Name: to.Ptr("plr1"),
		// 			Type: to.Ptr("Microsoft.Purview/accounts/privateLinkResources"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateLinkResources/plr1"),
		// 			Properties: &armpurview.PrivateLinkResourceProperties{
		// 				GroupID: to.Ptr("account1"),
		// 				RequiredMembers: []*string{
		// 					to.Ptr("account1")},
		// 					RequiredZoneNames: []*string{
		// 						to.Ptr("privatelinkzone1.service.azure.com")},
		// 					},
		// 				},
		// 				{
		// 					Name: to.Ptr("plr2"),
		// 					Type: to.Ptr("Microsoft.Purview/accounts/privateLinkResources"),
		// 					ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateLinkResources/plr2"),
		// 					Properties: &armpurview.PrivateLinkResourceProperties{
		// 						GroupID: to.Ptr("account2"),
		// 						RequiredMembers: []*string{
		// 							to.Ptr("account2")},
		// 							RequiredZoneNames: []*string{
		// 								to.Ptr("privatelinkzone2.service.azure.com")},
		// 							},
		// 					}},
		// 				}
	}
}

Output:

type PrivateLinkResourcesClientGetByGroupIDOptions added in v0.2.0 

type PrivateLinkResourcesClientGetByGroupIDOptions struct {
}

PrivateLinkResourcesClientGetByGroupIDOptions contains the optional parameters for the PrivateLinkResourcesClient.GetByGroupID method.

type PrivateLinkResourcesClientGetByGroupIDResponse added in v0.2.0 

type PrivateLinkResourcesClientGetByGroupIDResponse struct {
	// A privately linkable resource.
	PrivateLinkResource
}

PrivateLinkResourcesClientGetByGroupIDResponse contains the response from method PrivateLinkResourcesClient.GetByGroupID.

type PrivateLinkResourcesClientListByAccountOptions added in v0.2.0 

type PrivateLinkResourcesClientListByAccountOptions struct {
}

PrivateLinkResourcesClientListByAccountOptions contains the optional parameters for the PrivateLinkResourcesClient.NewListByAccountPager method.

type PrivateLinkResourcesClientListByAccountResponse added in v0.2.0 

type PrivateLinkResourcesClientListByAccountResponse struct {
	// Paged list of private link resources
	PrivateLinkResourceList
}

PrivateLinkResourcesClientListByAccountResponse contains the response from method PrivateLinkResourcesClient.NewListByAccountPager.

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	// The required actions.
	ActionsRequired *string

	// The description.
	Description *string

	// The status.
	Status *Status
}

PrivateLinkServiceConnectionState - The private link service connection state.

func (PrivateLinkServiceConnectionState) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type PrivateLinkServiceConnectionState.

func (*PrivateLinkServiceConnectionState) UnmarshalJSON added in v1.1.0 

func (p *PrivateLinkServiceConnectionState) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkServiceConnectionState.

type ProvisioningState 

type ProvisioningState string

ProvisioningState - Gets or sets the state of the provisioning. 

const (
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateCreating     ProvisioningState = "Creating"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateMoving       ProvisioningState = "Moving"
	ProvisioningStateSoftDeleted  ProvisioningState = "SoftDeleted"
	ProvisioningStateSoftDeleting ProvisioningState = "SoftDeleting"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUnknown      ProvisioningState = "Unknown"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type ProxyResource 

type ProxyResource struct {
	// READ-ONLY; Gets or sets the identifier.
	ID *string

	// READ-ONLY; Gets or sets the name.
	Name *string

	// READ-ONLY; Gets or sets the type.
	Type *string
}

ProxyResource - Proxy Azure Resource

func (ProxyResource) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type ProxyResource.

func (*ProxyResource) UnmarshalJSON added in v1.1.0 

func (p *ProxyResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProxyResource.

type PublicNetworkAccess 

type PublicNetworkAccess string

PublicNetworkAccess - Gets or sets the public network access. 

const (
	PublicNetworkAccessDisabled     PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled      PublicNetworkAccess = "Enabled"
	PublicNetworkAccessNotSpecified PublicNetworkAccess = "NotSpecified"
)

func PossiblePublicNetworkAccessValues 

func PossiblePublicNetworkAccessValues() []PublicNetworkAccess

PossiblePublicNetworkAccessValues returns the possible values for the PublicNetworkAccess const type.

type Reason 

type Reason string

Reason - The reason the name is not available. 

const (
	ReasonAlreadyExists Reason = "AlreadyExists"
	ReasonInvalid       Reason = "Invalid"
)

func PossibleReasonValues 

func PossibleReasonValues() []Reason

PossibleReasonValues returns the possible values for the Reason const type.

type ScopeType 

type ScopeType string

ScopeType - The scope where the default account is set. 

const (
	ScopeTypeSubscription ScopeType = "Subscription"
	ScopeTypeTenant       ScopeType = "Tenant"
)

func PossibleScopeTypeValues 

func PossibleScopeTypeValues() []ScopeType

PossibleScopeTypeValues returns the possible values for the ScopeType const type.

type Status 

type Status string

Status - The status. 

const (
	StatusApproved     Status = "Approved"
	StatusDisconnected Status = "Disconnected"
	StatusPending      Status = "Pending"
	StatusRejected     Status = "Rejected"
	StatusUnknown      Status = "Unknown"
)

func PossibleStatusValues 

func PossibleStatusValues() []Status

PossibleStatusValues returns the possible values for the Status const type.

type SystemData 

type SystemData struct {
	// READ-ONLY; The timestamp of resource creation (UTC).
	CreatedAt *time.Time

	// READ-ONLY; The identity that created the resource.
	CreatedBy *string

	// READ-ONLY; The type of identity that created the resource.
	CreatedByType *CreatedByType

	// READ-ONLY; The timestamp of the last modification the resource (UTC).
	LastModifiedAt *time.Time

	// READ-ONLY; The identity that last modified the resource.
	LastModifiedBy *string

	// READ-ONLY; The type of identity that last modified the resource.
	LastModifiedByType *LastModifiedByType
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON 

func (s SystemData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON 

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type TrackedResource 

type TrackedResource struct {
	// Identity Info on the tracked resource
	Identity *Identity

	// Gets or sets the location.
	Location *string

	// Tags on the azure resource.
	Tags map[string]*string

	// READ-ONLY; Gets or sets the identifier.
	ID *string

	// READ-ONLY; Gets or sets the name.
	Name *string

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *TrackedResourceSystemData

	// READ-ONLY; Gets or sets the type.
	Type *string
}

TrackedResource - Azure ARM Tracked Resource

func (TrackedResource) MarshalJSON 

func (t TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrackedResource.

func (*TrackedResource) UnmarshalJSON added in v1.1.0 

func (t *TrackedResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrackedResource.

type TrackedResourceSystemData 

type TrackedResourceSystemData struct {
	// READ-ONLY; The timestamp of resource creation (UTC).
	CreatedAt *time.Time

	// READ-ONLY; The identity that created the resource.
	CreatedBy *string

	// READ-ONLY; The type of identity that created the resource.
	CreatedByType *CreatedByType

	// READ-ONLY; The timestamp of the last modification the resource (UTC).
	LastModifiedAt *time.Time

	// READ-ONLY; The identity that last modified the resource.
	LastModifiedBy *string

	// READ-ONLY; The type of identity that last modified the resource.
	LastModifiedByType *LastModifiedByType
}

TrackedResourceSystemData - Metadata pertaining to creation and last modification of the resource.

func (TrackedResourceSystemData) MarshalJSON added in v0.2.0 

func (t TrackedResourceSystemData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrackedResourceSystemData.

func (*TrackedResourceSystemData) UnmarshalJSON added in v0.2.0 

func (t *TrackedResourceSystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrackedResourceSystemData.

type Type 

type Type string

Type - Identity Type 

const (
	TypeNone           Type = "None"
	TypeSystemAssigned Type = "SystemAssigned"
	TypeUserAssigned   Type = "UserAssigned"
)

func PossibleTypeValues 

func PossibleTypeValues() []Type

PossibleTypeValues returns the possible values for the Type const type.

type UserAssignedIdentity added in v0.2.0 

type UserAssignedIdentity struct {
	// READ-ONLY; Gets or Sets Client ID
	ClientID *string

	// READ-ONLY; Gets or Sets Principal ID
	PrincipalID *string
}

UserAssignedIdentity - Uses client ID and Principal ID

func (UserAssignedIdentity) MarshalJSON added in v1.1.0 

func (u UserAssignedIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserAssignedIdentity.

func (*UserAssignedIdentity) UnmarshalJSON added in v1.1.0 

func (u *UserAssignedIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserAssignedIdentity.

Source Files

View all Source files

Directories

Path Synopsis

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.