armproviderhub

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: 2

README

Azure Provider HUB Module for Go

PkgGoDev

The armproviderhub module provides operations for working with Azure Provider HUB.

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 Provider HUB module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/providerhub/armproviderhub

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Provider HUB. 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 Provider HUB 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 := armproviderhub.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 := armproviderhub.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.NewClient()

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 Provider HUB 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 AuthorizationActionMapping

type AuthorizationActionMapping struct {
	Desired  *string
	Original *string
}

func (AuthorizationActionMapping) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type AuthorizationActionMapping.

func (*AuthorizationActionMapping) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type AuthorizationActionMapping.

type CanaryTrafficRegionRolloutConfiguration

type CanaryTrafficRegionRolloutConfiguration struct {
	Regions     []*string
	SkipRegions []*string
}

func (CanaryTrafficRegionRolloutConfiguration) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CanaryTrafficRegionRolloutConfiguration.

func (*CanaryTrafficRegionRolloutConfiguration) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type CanaryTrafficRegionRolloutConfiguration.

type CheckNameAvailabilitySpecifications

type CheckNameAvailabilitySpecifications struct {
	EnableDefaultValidation           *bool
	ResourceTypesWithCustomValidation []*string
}

func (CheckNameAvailabilitySpecifications) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CheckNameAvailabilitySpecifications.

func (*CheckNameAvailabilitySpecifications) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type CheckNameAvailabilitySpecifications.

type CheckinManifestInfo

type CheckinManifestInfo struct {
	// REQUIRED
	IsCheckedIn *bool

	// REQUIRED
	StatusMessage *string
	CommitID      *string
	PullRequest   *string
}

func (CheckinManifestInfo) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type CheckinManifestInfo.

func (*CheckinManifestInfo) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type CheckinManifestInfo.

type CheckinManifestParams

type CheckinManifestParams struct {
	// REQUIRED; The baseline ARM manifest location supplied to the checkin manifest operation.
	BaselineArmManifestLocation *string

	// REQUIRED; The environment supplied to the checkin manifest operation.
	Environment *string
}

func (CheckinManifestParams) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type CheckinManifestParams.

func (*CheckinManifestParams) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type CheckinManifestParams.

type Client added in v0.2.0

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

Client contains the methods for the ProviderHub group. Don't use this type directly, use NewClient() instead.

func NewClient added in v0.2.0

func NewClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*Client, error)

NewClient creates a new instance of Client with the specified values.

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

func (*Client) CheckinManifest added in v0.2.0

func (client *Client) CheckinManifest(ctx context.Context, providerNamespace string, checkinManifestParams CheckinManifestParams, options *ClientCheckinManifestOptions) (ClientCheckinManifestResponse, error)

CheckinManifest - Checkin the manifest. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • checkinManifestParams - The required body parameters supplied to the checkin manifest operation.
  • options - ClientCheckinManifestOptions contains the optional parameters for the Client.CheckinManifest method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/CheckinManifest.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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewClient().CheckinManifest(ctx, "Microsoft.Contoso", armproviderhub.CheckinManifestParams{
		BaselineArmManifestLocation: to.Ptr("EastUS2EUAP"),
		Environment:                 to.Ptr("Prod"),
	}, 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.CheckinManifestInfo = armproviderhub.CheckinManifestInfo{
	// 	IsCheckedIn: to.Ptr(false),
	// 	StatusMessage: to.Ptr("Manifest is successfully merged. Use the Default/Custom rollout (http://aka.ms/rpaasrollout) to roll out the manifest in ARM."),
	// }
}
Output:

func (*Client) GenerateManifest added in v0.2.0

func (client *Client) GenerateManifest(ctx context.Context, providerNamespace string, options *ClientGenerateManifestOptions) (ClientGenerateManifestResponse, error)

GenerateManifest - Generates the manifest for the given provider. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • options - ClientGenerateManifestOptions contains the optional parameters for the Client.GenerateManifest method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/GenerateManifest.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewClient().GenerateManifest(ctx, "Microsoft.Contoso", 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.ResourceProviderManifest = armproviderhub.ResourceProviderManifest{
	// 	Capabilities: []*armproviderhub.ResourceProviderCapabilities{
	// 		{
	// 			Effect: to.Ptr(armproviderhub.ResourceProviderCapabilitiesEffectAllow),
	// 			QuotaID: to.Ptr("CSP_2015-05-01"),
	// 		},
	// 		{
	// 			Effect: to.Ptr(armproviderhub.ResourceProviderCapabilitiesEffectAllow),
	// 			QuotaID: to.Ptr("CSP_MG_2017-12-01"),
	// 	}},
	// 	GlobalNotificationEndpoints: []*armproviderhub.ResourceProviderEndpoint{
	// 		{
	// 			Enabled: to.Ptr(true),
	// 			EndpointURI: to.Ptr("https://notificationendpoint.com"),
	// 	}},
	// 	Management: &armproviderhub.ResourceProviderManifestManagement{
	// 		IncidentContactEmail: to.Ptr("helpme@contoso.com"),
	// 		IncidentRoutingService: to.Ptr(""),
	// 		IncidentRoutingTeam: to.Ptr(""),
	// 		ManifestOwners: []*string{
	// 			to.Ptr("manifestOwners-group")},
	// 			ResourceAccessPolicy: to.Ptr(armproviderhub.ResourceProviderManagementResourceAccessPolicyNotSpecified),
	// 		},
	// 		Metadata: map[string]any{
	// 			"onboardedVia": "ProviderHub",
	// 		},
	// 		Namespace: to.Ptr("microsoft.contoso"),
	// 		ProviderAuthorizations: []*armproviderhub.ResourceProviderAuthorization{
	// 			{
	// 				ApplicationID: to.Ptr("1a3b5c7d-8e9f-10g1-1h12-i13j14k1"),
	// 				RoleDefinitionID: to.Ptr("123456bf-gkur-2098-b890-98da392a00b2"),
	// 		}},
	// 		ProviderType: to.Ptr(armproviderhub.ResourceProviderType("Internal, Hidden")),
	// 		ProviderVersion: to.Ptr("2.0"),
	// 		ReRegisterSubscriptionMetadata: &armproviderhub.ResourceProviderManifestReRegisterSubscriptionMetadata{
	// 			ConcurrencyLimit: to.Ptr[int32](100),
	// 			Enabled: to.Ptr(true),
	// 		},
	// 		ResourceTypes: []*armproviderhub.ResourceType{
	// 			{
	// 				Name: to.Ptr("Operations"),
	// 				AllowedUnauthorizedActions: []*string{
	// 					to.Ptr("microsoft.contoso/operations/read")},
	// 					Endpoints: []*armproviderhub.ResourceProviderEndpoint{
	// 						{
	// 							APIVersions: []*string{
	// 								to.Ptr("2020-01-01-preview")},
	// 								EndpointURI: to.Ptr("https://resource-endpoint.com/"),
	// 								Locations: []*string{
	// 									to.Ptr("")},
	// 									Timeout: to.Ptr("PT20S"),
	// 							}},
	// 							LinkedOperationRules: []*armproviderhub.LinkedOperationRule{
	// 							},
	// 							ResourceValidation: to.Ptr(armproviderhub.ResourceValidation("ReservedWords, ProfaneWords")),
	// 							RoutingType: to.Ptr(armproviderhub.RoutingType("ProxyOnly, Tenant")),
	// 						},
	// 						{
	// 							Name: to.Ptr("Locations"),
	// 							Endpoints: []*armproviderhub.ResourceProviderEndpoint{
	// 								{
	// 									APIVersions: []*string{
	// 										to.Ptr("2020-01-01-preview")},
	// 										EndpointURI: to.Ptr("https://resource-endpoint.com/"),
	// 										Locations: []*string{
	// 											to.Ptr("")},
	// 											Timeout: to.Ptr("PT20S"),
	// 									}},
	// 									LinkedOperationRules: []*armproviderhub.LinkedOperationRule{
	// 									},
	// 									ResourceValidation: to.Ptr(armproviderhub.ResourceValidation("ReservedWords, ProfaneWords")),
	// 									RoutingType: to.Ptr(armproviderhub.RoutingTypeProxyOnly),
	// 							}},
	// 						}
}
Output:

type ClientCheckinManifestOptions added in v0.2.0

type ClientCheckinManifestOptions struct {
}

ClientCheckinManifestOptions contains the optional parameters for the Client.CheckinManifest method.

type ClientCheckinManifestResponse added in v0.2.0

type ClientCheckinManifestResponse struct {
	CheckinManifestInfo
}

ClientCheckinManifestResponse contains the response from method Client.CheckinManifest.

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 ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewClient added in v1.1.0

func (c *ClientFactory) NewClient() *Client

NewClient creates a new instance of Client.

func (*ClientFactory) NewCustomRolloutsClient added in v1.1.0

func (c *ClientFactory) NewCustomRolloutsClient() *CustomRolloutsClient

NewCustomRolloutsClient creates a new instance of CustomRolloutsClient.

func (*ClientFactory) NewDefaultRolloutsClient added in v1.1.0

func (c *ClientFactory) NewDefaultRolloutsClient() *DefaultRolloutsClient

NewDefaultRolloutsClient creates a new instance of DefaultRolloutsClient.

func (*ClientFactory) NewNotificationRegistrationsClient added in v1.1.0

func (c *ClientFactory) NewNotificationRegistrationsClient() *NotificationRegistrationsClient

NewNotificationRegistrationsClient creates a new instance of NotificationRegistrationsClient.

func (*ClientFactory) NewOperationsClient added in v1.1.0

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewProviderRegistrationsClient added in v1.1.0

func (c *ClientFactory) NewProviderRegistrationsClient() *ProviderRegistrationsClient

NewProviderRegistrationsClient creates a new instance of ProviderRegistrationsClient.

func (*ClientFactory) NewResourceTypeRegistrationsClient added in v1.1.0

func (c *ClientFactory) NewResourceTypeRegistrationsClient() *ResourceTypeRegistrationsClient

NewResourceTypeRegistrationsClient creates a new instance of ResourceTypeRegistrationsClient.

func (*ClientFactory) NewSKUsClient added in v1.1.0

func (c *ClientFactory) NewSKUsClient() *SKUsClient

NewSKUsClient creates a new instance of SKUsClient.

type ClientGenerateManifestOptions added in v0.2.0

type ClientGenerateManifestOptions struct {
}

ClientGenerateManifestOptions contains the optional parameters for the Client.GenerateManifest method.

type ClientGenerateManifestResponse added in v0.2.0

type ClientGenerateManifestResponse struct {
	ResourceProviderManifest
}

ClientGenerateManifestResponse contains the response from method Client.GenerateManifest.

type CustomRollout

type CustomRollout struct {
	// REQUIRED; Properties of the rollout.
	Properties *CustomRolloutProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

CustomRollout - Rollout details.

func (CustomRollout) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type CustomRollout.

func (*CustomRollout) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomRollout.

type CustomRolloutArrayResponseWithContinuation

type CustomRolloutArrayResponseWithContinuation struct {
	// The URL to get to the next set of results, if there are any.
	NextLink *string
	Value    []*CustomRollout
}

func (CustomRolloutArrayResponseWithContinuation) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type CustomRolloutArrayResponseWithContinuation.

func (*CustomRolloutArrayResponseWithContinuation) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomRolloutArrayResponseWithContinuation.

type CustomRolloutProperties

type CustomRolloutProperties struct {
	// REQUIRED
	Specification     *CustomRolloutPropertiesSpecification
	ProvisioningState *ProvisioningState
	Status            *CustomRolloutPropertiesStatus
}

CustomRolloutProperties - Properties of the rollout.

func (CustomRolloutProperties) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type CustomRolloutProperties.

func (*CustomRolloutProperties) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomRolloutProperties.

type CustomRolloutPropertiesAutoGenerated

type CustomRolloutPropertiesAutoGenerated struct {
	// REQUIRED
	Specification     *CustomRolloutPropertiesSpecification
	ProvisioningState *ProvisioningState
	Status            *CustomRolloutPropertiesStatus
}

func (CustomRolloutPropertiesAutoGenerated) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type CustomRolloutPropertiesAutoGenerated.

func (*CustomRolloutPropertiesAutoGenerated) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomRolloutPropertiesAutoGenerated.

type CustomRolloutPropertiesSpecification

type CustomRolloutPropertiesSpecification struct {
	// REQUIRED
	Canary                    *CustomRolloutSpecificationCanary
	ProviderRegistration      *CustomRolloutSpecificationProviderRegistration
	ResourceTypeRegistrations []*ResourceTypeRegistration
}

func (CustomRolloutPropertiesSpecification) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type CustomRolloutPropertiesSpecification.

func (*CustomRolloutPropertiesSpecification) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomRolloutPropertiesSpecification.

type CustomRolloutPropertiesStatus

type CustomRolloutPropertiesStatus struct {
	CompletedRegions []*string

	// Dictionary of
	FailedOrSkippedRegions map[string]*ExtendedErrorInfo
}

func (CustomRolloutPropertiesStatus) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type CustomRolloutPropertiesStatus.

func (*CustomRolloutPropertiesStatus) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomRolloutPropertiesStatus.

type CustomRolloutSpecification

type CustomRolloutSpecification struct {
	// REQUIRED
	Canary                    *CustomRolloutSpecificationCanary
	ProviderRegistration      *CustomRolloutSpecificationProviderRegistration
	ResourceTypeRegistrations []*ResourceTypeRegistration
}

func (CustomRolloutSpecification) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CustomRolloutSpecification.

func (*CustomRolloutSpecification) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomRolloutSpecification.

type CustomRolloutSpecificationCanary

type CustomRolloutSpecificationCanary struct {
	Regions []*string
}

func (CustomRolloutSpecificationCanary) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type CustomRolloutSpecificationCanary.

func (*CustomRolloutSpecificationCanary) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomRolloutSpecificationCanary.

type CustomRolloutSpecificationProviderRegistration

type CustomRolloutSpecificationProviderRegistration struct {
	Properties *ProviderRegistrationProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

func (CustomRolloutSpecificationProviderRegistration) MarshalJSON added in v1.1.0

MarshalJSON implements the json.Marshaller interface for type CustomRolloutSpecificationProviderRegistration.

func (*CustomRolloutSpecificationProviderRegistration) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type CustomRolloutSpecificationProviderRegistration.

type CustomRolloutStatus

type CustomRolloutStatus struct {
	CompletedRegions []*string

	// Dictionary of
	FailedOrSkippedRegions map[string]*ExtendedErrorInfo
}

func (CustomRolloutStatus) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CustomRolloutStatus.

func (*CustomRolloutStatus) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomRolloutStatus.

type CustomRolloutsClient

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

CustomRolloutsClient contains the methods for the CustomRollouts group. Don't use this type directly, use NewCustomRolloutsClient() instead.

func NewCustomRolloutsClient

func NewCustomRolloutsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*CustomRolloutsClient, error)

NewCustomRolloutsClient creates a new instance of CustomRolloutsClient with the specified values.

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

func (*CustomRolloutsClient) CreateOrUpdate

func (client *CustomRolloutsClient) CreateOrUpdate(ctx context.Context, providerNamespace string, rolloutName string, properties CustomRollout, options *CustomRolloutsClientCreateOrUpdateOptions) (CustomRolloutsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates the rollout details. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • rolloutName - The rollout name.
  • properties - The custom rollout properties supplied to the CreateOrUpdate operation.
  • options - CustomRolloutsClientCreateOrUpdateOptions contains the optional parameters for the CustomRolloutsClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/CustomRollouts_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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCustomRolloutsClient().CreateOrUpdate(ctx, "Microsoft.Contoso", "brazilUsShoeBoxTesting", armproviderhub.CustomRollout{
		Properties: &armproviderhub.CustomRolloutProperties{
			Specification: &armproviderhub.CustomRolloutPropertiesSpecification{
				Canary: &armproviderhub.CustomRolloutSpecificationCanary{
					Regions: []*string{
						to.Ptr("brazilus")},
				},
			},
		},
	}, 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.CustomRollout = armproviderhub.CustomRollout{
	// 	Name: to.Ptr("Microsoft.Contoso/brazilUsShoeBoxTesting"),
	// 	Type: to.Ptr("Microsoft.ProviderHub/providerRegistrations/customRollouts"),
	// 	ID: to.Ptr("/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/customRollouts/brazilUsShoeBoxTesting"),
	// 	Properties: &armproviderhub.CustomRolloutProperties{
	// 		ProvisioningState: to.Ptr(armproviderhub.ProvisioningStateSucceeded),
	// 		Specification: &armproviderhub.CustomRolloutPropertiesSpecification{
	// 			Canary: &armproviderhub.CustomRolloutSpecificationCanary{
	// 				Regions: []*string{
	// 					to.Ptr("brazilus"),
	// 					to.Ptr("eastus2euap"),
	// 					to.Ptr("centraluseuap")},
	// 				},
	// 			},
	// 			Status: &armproviderhub.CustomRolloutPropertiesStatus{
	// 				CompletedRegions: []*string{
	// 					to.Ptr("brazilus"),
	// 					to.Ptr("eastus2euap"),
	// 					to.Ptr("centraluseuap")},
	// 				},
	// 			},
	// 		}
}
Output:

func (*CustomRolloutsClient) Get

func (client *CustomRolloutsClient) Get(ctx context.Context, providerNamespace string, rolloutName string, options *CustomRolloutsClientGetOptions) (CustomRolloutsClientGetResponse, error)

Get - Gets the custom rollout details. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • rolloutName - The rollout name.
  • options - CustomRolloutsClientGetOptions contains the optional parameters for the CustomRolloutsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/CustomRollouts_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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCustomRolloutsClient().Get(ctx, "Microsoft.Contoso", "canaryTesting99", 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.CustomRollout = armproviderhub.CustomRollout{
	// 	Name: to.Ptr("Microsoft.Contoso/canaryTesting99"),
	// 	Type: to.Ptr("Microsoft.ProviderHub/providerRegistrations/customRollouts"),
	// 	ID: to.Ptr("/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/customRollouts/canaryTesting99"),
	// 	Properties: &armproviderhub.CustomRolloutProperties{
	// 		ProvisioningState: to.Ptr(armproviderhub.ProvisioningStateSucceeded),
	// 		Specification: &armproviderhub.CustomRolloutPropertiesSpecification{
	// 			Canary: &armproviderhub.CustomRolloutSpecificationCanary{
	// 				Regions: []*string{
	// 					to.Ptr("eastus2euap"),
	// 					to.Ptr("centraluseuap")},
	// 				},
	// 				ProviderRegistration: &armproviderhub.CustomRolloutSpecificationProviderRegistration{
	// 					Name: to.Ptr("Microsoft.Contoso"),
	// 					Type: to.Ptr("Microsoft.ProviderHub/providerRegistrations"),
	// 					ID: to.Ptr("/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso"),
	// 					Properties: &armproviderhub.ProviderRegistrationProperties{
	// 						Capabilities: []*armproviderhub.ResourceProviderCapabilities{
	// 							{
	// 								Effect: to.Ptr(armproviderhub.ResourceProviderCapabilitiesEffectAllow),
	// 								QuotaID: to.Ptr("CSP_2015-05-01"),
	// 							},
	// 							{
	// 								Effect: to.Ptr(armproviderhub.ResourceProviderCapabilitiesEffectAllow),
	// 								QuotaID: to.Ptr("CSP_MG_2017-12-01"),
	// 						}},
	// 						Management: &armproviderhub.ResourceProviderManifestPropertiesManagement{
	// 							IncidentContactEmail: to.Ptr("helpme@contoso.com"),
	// 							IncidentRoutingService: to.Ptr(""),
	// 							IncidentRoutingTeam: to.Ptr(""),
	// 							ManifestOwners: []*string{
	// 								to.Ptr("SPARTA-PlatformServiceAdministrator")},
	// 								ResourceAccessPolicy: to.Ptr(armproviderhub.ResourceProviderManagementResourceAccessPolicyNotSpecified),
	// 							},
	// 							Namespace: to.Ptr("microsoft.contoso"),
	// 							ProviderAuthorizations: []*armproviderhub.ResourceProviderAuthorization{
	// 								{
	// 									ApplicationID: to.Ptr("1a3b5c7d-8e9f-10g1-1h12-i13j14k1"),
	// 									RoleDefinitionID: to.Ptr("123456bf-gkur-2098-b890-98da392a00b2"),
	// 							}},
	// 							ProviderType: to.Ptr(armproviderhub.ResourceProviderType("Internal, Hidden")),
	// 							ProviderVersion: to.Ptr("2.0"),
	// 							ProviderHubMetadata: &armproviderhub.ProviderRegistrationPropertiesProviderHubMetadata{
	// 								ProviderAuthentication: &armproviderhub.MetadataProviderAuthentication{
	// 									AllowedAudiences: []*string{
	// 										to.Ptr("https://management.core.windows.net/")},
	// 									},
	// 								},
	// 								ProvisioningState: to.Ptr(armproviderhub.ProvisioningStateSucceeded),
	// 							},
	// 						},
	// 						ResourceTypeRegistrations: []*armproviderhub.ResourceTypeRegistration{
	// 							{
	// 								Name: to.Ptr("Microsoft.Contoso/employees"),
	// 								Type: to.Ptr("Microsoft.ProviderHub/providerRegistrations/resourceTypeRegistrations"),
	// 								ID: to.Ptr("/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/resourceTypeRegistrations/employees"),
	// 								Properties: &armproviderhub.ResourceTypeRegistrationProperties{
	// 									EnableAsyncOperation: to.Ptr(false),
	// 									EnableThirdPartyS2S: to.Ptr(false),
	// 									Endpoints: []*armproviderhub.ResourceTypeEndpoint{
	// 										{
	// 											APIVersions: []*string{
	// 												to.Ptr("2018-11-01-preview"),
	// 												to.Ptr("2020-01-01-preview"),
	// 												to.Ptr("2019-01-01")},
	// 												Locations: []*string{
	// 													to.Ptr("East Asia"),
	// 													to.Ptr("East US"),
	// 													to.Ptr("North Europe"),
	// 													to.Ptr("Southeast Asia"),
	// 													to.Ptr("East US 2 EUAP"),
	// 													to.Ptr("Central US EUAP"),
	// 													to.Ptr("West Europe"),
	// 													to.Ptr("West US"),
	// 													to.Ptr("West Central US"),
	// 													to.Ptr("West US 2")},
	// 													RequiredFeatures: []*string{
	// 														to.Ptr("Microsoft.Contoso/RPaaSSampleApp")},
	// 												}},
	// 												ProvisioningState: to.Ptr(armproviderhub.ProvisioningStateSucceeded),
	// 												Regionality: to.Ptr(armproviderhub.RegionalityRegional),
	// 												RoutingType: to.Ptr(armproviderhub.RoutingTypeDefault),
	// 												SwaggerSpecifications: []*armproviderhub.SwaggerSpecification{
	// 													{
	// 														APIVersions: []*string{
	// 															to.Ptr("2018-11-01-preview"),
	// 															to.Ptr("2020-01-01-preview"),
	// 															to.Ptr("2019-01-01")},
	// 															SwaggerSpecFolderURI: to.Ptr("https://github.com/Azure/azure-rest-api-specs/blob/feature/azure/contoso/specification/contoso/resource-manager/Microsoft.SampleRP/"),
	// 													}},
	// 												},
	// 										}},
	// 									},
	// 									Status: &armproviderhub.CustomRolloutPropertiesStatus{
	// 										CompletedRegions: []*string{
	// 											to.Ptr("eastus2euap"),
	// 											to.Ptr("centraluseuap")},
	// 										},
	// 									},
	// 								}
}
Output:

func (*CustomRolloutsClient) NewListByProviderRegistrationPager added in v0.4.0

NewListByProviderRegistrationPager - Gets the list of the custom rollouts for the given provider.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • options - CustomRolloutsClientListByProviderRegistrationOptions contains the optional parameters for the CustomRolloutsClient.NewListByProviderRegistrationPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/CustomRollouts_ListByProviderRegistration.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewCustomRolloutsClient().NewListByProviderRegistrationPager("Microsoft.Contoso", 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.CustomRolloutArrayResponseWithContinuation = armproviderhub.CustomRolloutArrayResponseWithContinuation{
		// 	Value: []*armproviderhub.CustomRollout{
		// 		{
		// 			Name: to.Ptr("Microsoft.Contoso/canaryTesting99"),
		// 			Type: to.Ptr("Microsoft.ProviderHub/providerRegistrations/customRollouts"),
		// 			ID: to.Ptr("/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/customRollouts/canaryTesting99"),
		// 			Properties: &armproviderhub.CustomRolloutProperties{
		// 				ProvisioningState: to.Ptr(armproviderhub.ProvisioningStateSucceeded),
		// 				Specification: &armproviderhub.CustomRolloutPropertiesSpecification{
		// 					Canary: &armproviderhub.CustomRolloutSpecificationCanary{
		// 						Regions: []*string{
		// 							to.Ptr("eastus2euap"),
		// 							to.Ptr("centraluseuap")},
		// 						},
		// 					},
		// 					Status: &armproviderhub.CustomRolloutPropertiesStatus{
		// 						CompletedRegions: []*string{
		// 							to.Ptr("eastus2euap"),
		// 							to.Ptr("centraluseuap")},
		// 						},
		// 					},
		// 				},
		// 				{
		// 					Name: to.Ptr("Microsoft.Contoso/brazilustesting"),
		// 					Type: to.Ptr("Microsoft.ProviderHub/providerRegistrations/customRollouts"),
		// 					ID: to.Ptr("/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/customRollouts/brazilustesting"),
		// 					Properties: &armproviderhub.CustomRolloutProperties{
		// 						ProvisioningState: to.Ptr(armproviderhub.ProvisioningStateSucceeded),
		// 						Specification: &armproviderhub.CustomRolloutPropertiesSpecification{
		// 							Canary: &armproviderhub.CustomRolloutSpecificationCanary{
		// 								Regions: []*string{
		// 									to.Ptr("brazilus")},
		// 								},
		// 							},
		// 							Status: &armproviderhub.CustomRolloutPropertiesStatus{
		// 								FailedOrSkippedRegions: map[string]*armproviderhub.ExtendedErrorInfo{
		// 									"brazilus": &armproviderhub.ExtendedErrorInfo{
		// 										Code: to.Ptr("RolloutTimedout"),
		// 										Message: to.Ptr("Failed to rollout to specified region."),
		// 									},
		// 								},
		// 							},
		// 						},
		// 				}},
		// 			}
	}
}
Output:

type CustomRolloutsClientCreateOrUpdateOptions added in v0.2.0

type CustomRolloutsClientCreateOrUpdateOptions struct {
}

CustomRolloutsClientCreateOrUpdateOptions contains the optional parameters for the CustomRolloutsClient.CreateOrUpdate method.

type CustomRolloutsClientCreateOrUpdateResponse added in v0.2.0

type CustomRolloutsClientCreateOrUpdateResponse struct {
	// Rollout details.
	CustomRollout
}

CustomRolloutsClientCreateOrUpdateResponse contains the response from method CustomRolloutsClient.CreateOrUpdate.

type CustomRolloutsClientGetOptions added in v0.2.0

type CustomRolloutsClientGetOptions struct {
}

CustomRolloutsClientGetOptions contains the optional parameters for the CustomRolloutsClient.Get method.

type CustomRolloutsClientGetResponse added in v0.2.0

type CustomRolloutsClientGetResponse struct {
	// Rollout details.
	CustomRollout
}

CustomRolloutsClientGetResponse contains the response from method CustomRolloutsClient.Get.

type CustomRolloutsClientListByProviderRegistrationOptions added in v0.2.0

type CustomRolloutsClientListByProviderRegistrationOptions struct {
}

CustomRolloutsClientListByProviderRegistrationOptions contains the optional parameters for the CustomRolloutsClient.NewListByProviderRegistrationPager method.

type CustomRolloutsClientListByProviderRegistrationResponse added in v0.2.0

type CustomRolloutsClientListByProviderRegistrationResponse struct {
	CustomRolloutArrayResponseWithContinuation
}

CustomRolloutsClientListByProviderRegistrationResponse contains the response from method CustomRolloutsClient.NewListByProviderRegistrationPager.

type DefaultRollout

type DefaultRollout struct {
	// Properties of the rollout.
	Properties *DefaultRolloutProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

DefaultRollout - Default rollout definition.

func (DefaultRollout) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type DefaultRollout.

func (*DefaultRollout) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultRollout.

type DefaultRolloutArrayResponseWithContinuation

type DefaultRolloutArrayResponseWithContinuation struct {
	// The URL to get to the next set of results, if there are any.
	NextLink *string
	Value    []*DefaultRollout
}

func (DefaultRolloutArrayResponseWithContinuation) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type DefaultRolloutArrayResponseWithContinuation.

func (*DefaultRolloutArrayResponseWithContinuation) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultRolloutArrayResponseWithContinuation.

type DefaultRolloutProperties

type DefaultRolloutProperties struct {
	ProvisioningState *ProvisioningState
	Specification     *DefaultRolloutPropertiesSpecification
	Status            *DefaultRolloutPropertiesStatus
}

DefaultRolloutProperties - Properties of the rollout.

func (DefaultRolloutProperties) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type DefaultRolloutProperties.

func (*DefaultRolloutProperties) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultRolloutProperties.

type DefaultRolloutPropertiesAutoGenerated

type DefaultRolloutPropertiesAutoGenerated struct {
	ProvisioningState *ProvisioningState
	Specification     *DefaultRolloutPropertiesSpecification
	Status            *DefaultRolloutPropertiesStatus
}

func (DefaultRolloutPropertiesAutoGenerated) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type DefaultRolloutPropertiesAutoGenerated.

func (*DefaultRolloutPropertiesAutoGenerated) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultRolloutPropertiesAutoGenerated.

type DefaultRolloutPropertiesSpecification

func (DefaultRolloutPropertiesSpecification) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type DefaultRolloutPropertiesSpecification.

func (*DefaultRolloutPropertiesSpecification) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultRolloutPropertiesSpecification.

type DefaultRolloutPropertiesStatus

type DefaultRolloutPropertiesStatus struct {
	CompletedRegions []*string

	// Dictionary of
	FailedOrSkippedRegions           map[string]*ExtendedErrorInfo
	NextTrafficRegion                *TrafficRegionCategory
	NextTrafficRegionScheduledTime   *time.Time
	SubscriptionReregistrationResult *SubscriptionReregistrationResult
}

func (DefaultRolloutPropertiesStatus) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type DefaultRolloutPropertiesStatus.

func (*DefaultRolloutPropertiesStatus) UnmarshalJSON added in v0.2.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultRolloutPropertiesStatus.

type DefaultRolloutSpecification

func (DefaultRolloutSpecification) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DefaultRolloutSpecification.

func (*DefaultRolloutSpecification) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultRolloutSpecification.

type DefaultRolloutSpecificationCanary

type DefaultRolloutSpecificationCanary struct {
	Regions     []*string
	SkipRegions []*string
}

func (DefaultRolloutSpecificationCanary) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type DefaultRolloutSpecificationCanary.

func (*DefaultRolloutSpecificationCanary) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultRolloutSpecificationCanary.

type DefaultRolloutSpecificationHighTraffic

type DefaultRolloutSpecificationHighTraffic struct {
	Regions      []*string
	WaitDuration *string
}

func (DefaultRolloutSpecificationHighTraffic) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type DefaultRolloutSpecificationHighTraffic.

func (*DefaultRolloutSpecificationHighTraffic) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultRolloutSpecificationHighTraffic.

type DefaultRolloutSpecificationLowTraffic

type DefaultRolloutSpecificationLowTraffic struct {
	Regions      []*string
	WaitDuration *string
}

func (DefaultRolloutSpecificationLowTraffic) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type DefaultRolloutSpecificationLowTraffic.

func (*DefaultRolloutSpecificationLowTraffic) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultRolloutSpecificationLowTraffic.

type DefaultRolloutSpecificationMediumTraffic

type DefaultRolloutSpecificationMediumTraffic struct {
	Regions      []*string
	WaitDuration *string
}

func (DefaultRolloutSpecificationMediumTraffic) MarshalJSON added in v0.2.0

MarshalJSON implements the json.Marshaller interface for type DefaultRolloutSpecificationMediumTraffic.

func (*DefaultRolloutSpecificationMediumTraffic) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultRolloutSpecificationMediumTraffic.

type DefaultRolloutSpecificationProviderRegistration

type DefaultRolloutSpecificationProviderRegistration struct {
	Properties *ProviderRegistrationProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

func (DefaultRolloutSpecificationProviderRegistration) MarshalJSON added in v1.1.0

MarshalJSON implements the json.Marshaller interface for type DefaultRolloutSpecificationProviderRegistration.

func (*DefaultRolloutSpecificationProviderRegistration) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultRolloutSpecificationProviderRegistration.

type DefaultRolloutSpecificationRestOfTheWorldGroupOne

type DefaultRolloutSpecificationRestOfTheWorldGroupOne struct {
	Regions      []*string
	WaitDuration *string
}

func (DefaultRolloutSpecificationRestOfTheWorldGroupOne) MarshalJSON added in v0.2.0

MarshalJSON implements the json.Marshaller interface for type DefaultRolloutSpecificationRestOfTheWorldGroupOne.

func (*DefaultRolloutSpecificationRestOfTheWorldGroupOne) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultRolloutSpecificationRestOfTheWorldGroupOne.

type DefaultRolloutSpecificationRestOfTheWorldGroupTwo

type DefaultRolloutSpecificationRestOfTheWorldGroupTwo struct {
	Regions      []*string
	WaitDuration *string
}

func (DefaultRolloutSpecificationRestOfTheWorldGroupTwo) MarshalJSON added in v0.2.0

MarshalJSON implements the json.Marshaller interface for type DefaultRolloutSpecificationRestOfTheWorldGroupTwo.

func (*DefaultRolloutSpecificationRestOfTheWorldGroupTwo) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultRolloutSpecificationRestOfTheWorldGroupTwo.

type DefaultRolloutStatus

type DefaultRolloutStatus struct {
	CompletedRegions []*string

	// Dictionary of
	FailedOrSkippedRegions           map[string]*ExtendedErrorInfo
	NextTrafficRegion                *TrafficRegionCategory
	NextTrafficRegionScheduledTime   *time.Time
	SubscriptionReregistrationResult *SubscriptionReregistrationResult
}

func (DefaultRolloutStatus) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DefaultRolloutStatus.

func (*DefaultRolloutStatus) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultRolloutStatus.

type DefaultRolloutsClient

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

DefaultRolloutsClient contains the methods for the DefaultRollouts group. Don't use this type directly, use NewDefaultRolloutsClient() instead.

func NewDefaultRolloutsClient

func NewDefaultRolloutsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DefaultRolloutsClient, error)

NewDefaultRolloutsClient creates a new instance of DefaultRolloutsClient with the specified values.

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

func (*DefaultRolloutsClient) BeginCreateOrUpdate

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

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • rolloutName - The rollout name.
  • properties - The Default rollout properties supplied to the CreateOrUpdate operation.
  • options - DefaultRolloutsClientBeginCreateOrUpdateOptions contains the optional parameters for the DefaultRolloutsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/DefaultRollouts_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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDefaultRolloutsClient().BeginCreateOrUpdate(ctx, "Microsoft.Contoso", "2020week10", armproviderhub.DefaultRollout{
		Properties: &armproviderhub.DefaultRolloutProperties{
			Specification: &armproviderhub.DefaultRolloutPropertiesSpecification{
				Canary: &armproviderhub.DefaultRolloutSpecificationCanary{
					SkipRegions: []*string{
						to.Ptr("eastus2euap")},
				},
				RestOfTheWorldGroupTwo: &armproviderhub.DefaultRolloutSpecificationRestOfTheWorldGroupTwo{
					WaitDuration: to.Ptr("PT4H"),
				},
			},
		},
	}, 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.DefaultRollout = armproviderhub.DefaultRollout{
	// 	Name: to.Ptr("Microsoft.Contoso/2020week10"),
	// 	Type: to.Ptr("Microsoft.ProviderHub/providerRegistrations/defaultRollouts"),
	// 	ID: to.Ptr("/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/defaultRollouts/2020week10"),
	// 	Properties: &armproviderhub.DefaultRolloutProperties{
	// 		ProvisioningState: to.Ptr(armproviderhub.ProvisioningStateSucceeded),
	// 		Specification: &armproviderhub.DefaultRolloutPropertiesSpecification{
	// 			Canary: &armproviderhub.DefaultRolloutSpecificationCanary{
	// 				Regions: []*string{
	// 					to.Ptr("brazilus"),
	// 					to.Ptr("eastus2euap"),
	// 					to.Ptr("centraluseuap")},
	// 				},
	// 				HighTraffic: &armproviderhub.DefaultRolloutSpecificationHighTraffic{
	// 					Regions: []*string{
	// 						to.Ptr("australiasoutheast"),
	// 						to.Ptr("otherhightraficregions")},
	// 						WaitDuration: to.Ptr("PT24H"),
	// 					},
	// 					LowTraffic: &armproviderhub.DefaultRolloutSpecificationLowTraffic{
	// 						Regions: []*string{
	// 							to.Ptr("southeastasia")},
	// 							WaitDuration: to.Ptr("PT24H"),
	// 						},
	// 						MediumTraffic: &armproviderhub.DefaultRolloutSpecificationMediumTraffic{
	// 							Regions: []*string{
	// 								to.Ptr("uksouth"),
	// 								to.Ptr("indiawest")},
	// 								WaitDuration: to.Ptr("PT24H"),
	// 							},
	// 							RestOfTheWorldGroupOne: &armproviderhub.DefaultRolloutSpecificationRestOfTheWorldGroupOne{
	// 								Regions: []*string{
	// 									to.Ptr("koreacentral"),
	// 									to.Ptr("francecentral"),
	// 									to.Ptr("australiacentral"),
	// 									to.Ptr("westus"),
	// 									to.Ptr("allotherregions")},
	// 									WaitDuration: to.Ptr("PT4H"),
	// 								},
	// 								RestOfTheWorldGroupTwo: &armproviderhub.DefaultRolloutSpecificationRestOfTheWorldGroupTwo{
	// 									Regions: []*string{
	// 										to.Ptr("germanynorth"),
	// 										to.Ptr("norwayeast"),
	// 										to.Ptr("allotherregions")},
	// 										WaitDuration: to.Ptr("PT4H"),
	// 									},
	// 								},
	// 								Status: &armproviderhub.DefaultRolloutPropertiesStatus{
	// 									CompletedRegions: []*string{
	// 										to.Ptr("brazilus"),
	// 										to.Ptr("eastus2euap"),
	// 										to.Ptr("centraluseuap"),
	// 										to.Ptr("allcompletedregions")},
	// 									},
	// 								},
	// 							}
}
Output:

func (*DefaultRolloutsClient) Delete

func (client *DefaultRolloutsClient) Delete(ctx context.Context, providerNamespace string, rolloutName string, options *DefaultRolloutsClientDeleteOptions) (DefaultRolloutsClientDeleteResponse, error)

Delete - Deletes the rollout resource. Rollout must be in terminal state. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • rolloutName - The rollout name.
  • options - DefaultRolloutsClientDeleteOptions contains the optional parameters for the DefaultRolloutsClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/DefaultRollouts_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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewDefaultRolloutsClient().Delete(ctx, "Microsoft.Contoso", "2020week10", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*DefaultRolloutsClient) Get

func (client *DefaultRolloutsClient) Get(ctx context.Context, providerNamespace string, rolloutName string, options *DefaultRolloutsClientGetOptions) (DefaultRolloutsClientGetResponse, error)

Get - Gets the default rollout details. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • rolloutName - The rollout name.
  • options - DefaultRolloutsClientGetOptions contains the optional parameters for the DefaultRolloutsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/DefaultRollouts_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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDefaultRolloutsClient().Get(ctx, "Microsoft.Contoso", "2020week10", 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.DefaultRollout = armproviderhub.DefaultRollout{
	// 	Name: to.Ptr("Microsoft.Contoso/2020week10"),
	// 	Type: to.Ptr("Microsoft.ProviderHub/providerRegistrations/defaultRollouts"),
	// 	ID: to.Ptr("/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/defaultRollouts/2020week10"),
	// 	Properties: &armproviderhub.DefaultRolloutProperties{
	// 		ProvisioningState: to.Ptr(armproviderhub.ProvisioningStateSucceeded),
	// 		Specification: &armproviderhub.DefaultRolloutPropertiesSpecification{
	// 			Canary: &armproviderhub.DefaultRolloutSpecificationCanary{
	// 				Regions: []*string{
	// 					to.Ptr("eastus2euap"),
	// 					to.Ptr("centraluseuap")},
	// 					SkipRegions: []*string{
	// 						to.Ptr("brazilus")},
	// 					},
	// 					HighTraffic: &armproviderhub.DefaultRolloutSpecificationHighTraffic{
	// 						Regions: []*string{
	// 							to.Ptr("australiasoutheast"),
	// 							to.Ptr("otherhightraficregions")},
	// 							WaitDuration: to.Ptr("PT24H"),
	// 						},
	// 						LowTraffic: &armproviderhub.DefaultRolloutSpecificationLowTraffic{
	// 							Regions: []*string{
	// 								to.Ptr("southeastasia")},
	// 								WaitDuration: to.Ptr("PT24H"),
	// 							},
	// 							MediumTraffic: &armproviderhub.DefaultRolloutSpecificationMediumTraffic{
	// 								Regions: []*string{
	// 									to.Ptr("uksouth"),
	// 									to.Ptr("indiawest")},
	// 									WaitDuration: to.Ptr("PT24H"),
	// 								},
	// 								ProviderRegistration: &armproviderhub.DefaultRolloutSpecificationProviderRegistration{
	// 									Name: to.Ptr("Microsoft.Contoso"),
	// 									Type: to.Ptr("Microsoft.ProviderHub/providerRegistrations"),
	// 									ID: to.Ptr("/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso"),
	// 									Properties: &armproviderhub.ProviderRegistrationProperties{
	// 										Capabilities: []*armproviderhub.ResourceProviderCapabilities{
	// 											{
	// 												Effect: to.Ptr(armproviderhub.ResourceProviderCapabilitiesEffectAllow),
	// 												QuotaID: to.Ptr("CSP_2015-05-01"),
	// 											},
	// 											{
	// 												Effect: to.Ptr(armproviderhub.ResourceProviderCapabilitiesEffectAllow),
	// 												QuotaID: to.Ptr("CSP_MG_2017-12-01"),
	// 										}},
	// 										Management: &armproviderhub.ResourceProviderManifestPropertiesManagement{
	// 											IncidentContactEmail: to.Ptr("helpme@contoso.com"),
	// 											IncidentRoutingService: to.Ptr(""),
	// 											IncidentRoutingTeam: to.Ptr(""),
	// 											ManifestOwners: []*string{
	// 												to.Ptr("SPARTA-PlatformServiceAdministrator")},
	// 												ResourceAccessPolicy: to.Ptr(armproviderhub.ResourceProviderManagementResourceAccessPolicyNotSpecified),
	// 											},
	// 											Namespace: to.Ptr("microsoft.contoso"),
	// 											ProviderAuthorizations: []*armproviderhub.ResourceProviderAuthorization{
	// 												{
	// 													ApplicationID: to.Ptr("1a3b5c7d-8e9f-10g1-1h12-i13j14k1"),
	// 													RoleDefinitionID: to.Ptr("123456bf-gkur-2098-b890-98da392a00b2"),
	// 											}},
	// 											ProviderType: to.Ptr(armproviderhub.ResourceProviderType("Internal, Hidden")),
	// 											ProviderVersion: to.Ptr("2.0"),
	// 											ProviderHubMetadata: &armproviderhub.ProviderRegistrationPropertiesProviderHubMetadata{
	// 												ProviderAuthentication: &armproviderhub.MetadataProviderAuthentication{
	// 													AllowedAudiences: []*string{
	// 														to.Ptr("https://management.core.windows.net/")},
	// 													},
	// 												},
	// 												ProvisioningState: to.Ptr(armproviderhub.ProvisioningStateSucceeded),
	// 											},
	// 										},
	// 										ResourceTypeRegistrations: []*armproviderhub.ResourceTypeRegistration{
	// 											{
	// 												Name: to.Ptr("Microsoft.Contoso/employees"),
	// 												Type: to.Ptr("Microsoft.ProviderHub/providerRegistrations/resourceTypeRegistrations"),
	// 												ID: to.Ptr("/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/resourceTypeRegistrations/employees"),
	// 												Properties: &armproviderhub.ResourceTypeRegistrationProperties{
	// 													EnableAsyncOperation: to.Ptr(false),
	// 													EnableThirdPartyS2S: to.Ptr(false),
	// 													Endpoints: []*armproviderhub.ResourceTypeEndpoint{
	// 														{
	// 															APIVersions: []*string{
	// 																to.Ptr("2018-11-01-preview"),
	// 																to.Ptr("2020-01-01-preview"),
	// 																to.Ptr("2019-01-01")},
	// 																Locations: []*string{
	// 																	to.Ptr("East Asia"),
	// 																	to.Ptr("East US"),
	// 																	to.Ptr("North Europe"),
	// 																	to.Ptr("Southeast Asia"),
	// 																	to.Ptr("East US 2 EUAP"),
	// 																	to.Ptr("Central US EUAP"),
	// 																	to.Ptr("West Europe"),
	// 																	to.Ptr("West US"),
	// 																	to.Ptr("West Central US"),
	// 																	to.Ptr("West US 2")},
	// 																	RequiredFeatures: []*string{
	// 																		to.Ptr("Microsoft.Contoso/RPaaSSampleApp")},
	// 																}},
	// 																ProvisioningState: to.Ptr(armproviderhub.ProvisioningStateSucceeded),
	// 																Regionality: to.Ptr(armproviderhub.RegionalityRegional),
	// 																RoutingType: to.Ptr(armproviderhub.RoutingTypeDefault),
	// 																SwaggerSpecifications: []*armproviderhub.SwaggerSpecification{
	// 																	{
	// 																		APIVersions: []*string{
	// 																			to.Ptr("2018-11-01-preview"),
	// 																			to.Ptr("2020-01-01-preview"),
	// 																			to.Ptr("2019-01-01")},
	// 																			SwaggerSpecFolderURI: to.Ptr("https://github.com/Azure/azure-rest-api-specs/blob/feature/azure/contoso/specification/contoso/resource-manager/Microsoft.SampleRP/"),
	// 																	}},
	// 																},
	// 														}},
	// 														RestOfTheWorldGroupOne: &armproviderhub.DefaultRolloutSpecificationRestOfTheWorldGroupOne{
	// 															Regions: []*string{
	// 																to.Ptr("koreacentral"),
	// 																to.Ptr("francecentral"),
	// 																to.Ptr("australiacentral"),
	// 																to.Ptr("westus"),
	// 																to.Ptr("allotherregions")},
	// 																WaitDuration: to.Ptr("PT4H"),
	// 															},
	// 															RestOfTheWorldGroupTwo: &armproviderhub.DefaultRolloutSpecificationRestOfTheWorldGroupTwo{
	// 																Regions: []*string{
	// 																	to.Ptr("germanynorth"),
	// 																	to.Ptr("norwayeast"),
	// 																	to.Ptr("allotherregions")},
	// 																	WaitDuration: to.Ptr("PT4H"),
	// 																},
	// 															},
	// 															Status: &armproviderhub.DefaultRolloutPropertiesStatus{
	// 																CompletedRegions: []*string{
	// 																	to.Ptr("brazilus"),
	// 																	to.Ptr("eastus2euap"),
	// 																	to.Ptr("centraluseuap"),
	// 																	to.Ptr("allcompletedregions")},
	// 																	FailedOrSkippedRegions: map[string]*armproviderhub.ExtendedErrorInfo{
	// 																		"westus2": &armproviderhub.ExtendedErrorInfo{
	// 																			Code: to.Ptr("RolloutStoppedByUser"),
	// 																			Message: to.Ptr("Rollout was explicitly stopped by the user."),
	// 																		},
	// 																	},
	// 																	SubscriptionReregistrationResult: to.Ptr(armproviderhub.SubscriptionReregistrationResultConditionalUpdate),
	// 																},
	// 															},
	// 														}
}
Output:

func (*DefaultRolloutsClient) NewListByProviderRegistrationPager added in v0.4.0

NewListByProviderRegistrationPager - Gets the list of the rollouts for the given provider.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • options - DefaultRolloutsClientListByProviderRegistrationOptions contains the optional parameters for the DefaultRolloutsClient.NewListByProviderRegistrationPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/DefaultRollouts_ListByProviderRegistration.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewDefaultRolloutsClient().NewListByProviderRegistrationPager("Microsoft.Contoso", 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.DefaultRolloutArrayResponseWithContinuation = armproviderhub.DefaultRolloutArrayResponseWithContinuation{
		// 	Value: []*armproviderhub.DefaultRollout{
		// 		{
		// 			Name: to.Ptr("Microsoft.Contoso/2020week01"),
		// 			Type: to.Ptr("Microsoft.ProviderHub/providerRegistrations/defaultRollouts"),
		// 			ID: to.Ptr("/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/defaultRollouts/2020week01"),
		// 			Properties: &armproviderhub.DefaultRolloutProperties{
		// 				ProvisioningState: to.Ptr(armproviderhub.ProvisioningStateSucceeded),
		// 				Specification: &armproviderhub.DefaultRolloutPropertiesSpecification{
		// 					Canary: &armproviderhub.DefaultRolloutSpecificationCanary{
		// 						Regions: []*string{
		// 							to.Ptr("brazilus"),
		// 							to.Ptr("eastus2euap"),
		// 							to.Ptr("centraluseuap")},
		// 						},
		// 						HighTraffic: &armproviderhub.DefaultRolloutSpecificationHighTraffic{
		// 							Regions: []*string{
		// 								to.Ptr("australiasoutheast"),
		// 								to.Ptr("otherhightraficregions")},
		// 								WaitDuration: to.Ptr("PT24H"),
		// 							},
		// 							LowTraffic: &armproviderhub.DefaultRolloutSpecificationLowTraffic{
		// 								Regions: []*string{
		// 									to.Ptr("southeastasia")},
		// 									WaitDuration: to.Ptr("PT24H"),
		// 								},
		// 								MediumTraffic: &armproviderhub.DefaultRolloutSpecificationMediumTraffic{
		// 									Regions: []*string{
		// 										to.Ptr("uksouth"),
		// 										to.Ptr("indiawest")},
		// 										WaitDuration: to.Ptr("PT24H"),
		// 									},
		// 									RestOfTheWorldGroupOne: &armproviderhub.DefaultRolloutSpecificationRestOfTheWorldGroupOne{
		// 										Regions: []*string{
		// 											to.Ptr("koreacentral"),
		// 											to.Ptr("francecentral"),
		// 											to.Ptr("australiacentral"),
		// 											to.Ptr("westus"),
		// 											to.Ptr("allotherregions")},
		// 											WaitDuration: to.Ptr("PT4H"),
		// 										},
		// 										RestOfTheWorldGroupTwo: &armproviderhub.DefaultRolloutSpecificationRestOfTheWorldGroupTwo{
		// 											Regions: []*string{
		// 												to.Ptr("germanynorth"),
		// 												to.Ptr("norwayeast"),
		// 												to.Ptr("allotherregions")},
		// 												WaitDuration: to.Ptr("PT4H"),
		// 											},
		// 										},
		// 										Status: &armproviderhub.DefaultRolloutPropertiesStatus{
		// 											CompletedRegions: []*string{
		// 												to.Ptr("brazilus"),
		// 												to.Ptr("eastus2euap"),
		// 												to.Ptr("centraluseuap"),
		// 												to.Ptr("allcompletedregions")},
		// 											},
		// 										},
		// 									},
		// 									{
		// 										Name: to.Ptr("Microsoft.Contoso/2020week10"),
		// 										Type: to.Ptr("Microsoft.ProviderHub/providerRegistrations/defaultRollouts"),
		// 										ID: to.Ptr("/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/defaultRollouts/2020week10"),
		// 										Properties: &armproviderhub.DefaultRolloutProperties{
		// 											ProvisioningState: to.Ptr(armproviderhub.ProvisioningStateSucceeded),
		// 											Specification: &armproviderhub.DefaultRolloutPropertiesSpecification{
		// 												Canary: &armproviderhub.DefaultRolloutSpecificationCanary{
		// 													Regions: []*string{
		// 														to.Ptr("brazilus"),
		// 														to.Ptr("eastus2euap"),
		// 														to.Ptr("centraluseuap")},
		// 													},
		// 													HighTraffic: &armproviderhub.DefaultRolloutSpecificationHighTraffic{
		// 														Regions: []*string{
		// 															to.Ptr("australiasoutheast"),
		// 															to.Ptr("otherhightraficregions")},
		// 															WaitDuration: to.Ptr("PT24H"),
		// 														},
		// 														LowTraffic: &armproviderhub.DefaultRolloutSpecificationLowTraffic{
		// 															Regions: []*string{
		// 																to.Ptr("southeastasia")},
		// 																WaitDuration: to.Ptr("PT24H"),
		// 															},
		// 															MediumTraffic: &armproviderhub.DefaultRolloutSpecificationMediumTraffic{
		// 																Regions: []*string{
		// 																	to.Ptr("uksouth"),
		// 																	to.Ptr("indiawest")},
		// 																	WaitDuration: to.Ptr("PT24H"),
		// 																},
		// 																RestOfTheWorldGroupOne: &armproviderhub.DefaultRolloutSpecificationRestOfTheWorldGroupOne{
		// 																	Regions: []*string{
		// 																		to.Ptr("koreacentral"),
		// 																		to.Ptr("francecentral"),
		// 																		to.Ptr("australiacentral"),
		// 																		to.Ptr("westus"),
		// 																		to.Ptr("allotherregions")},
		// 																		WaitDuration: to.Ptr("PT4H"),
		// 																	},
		// 																	RestOfTheWorldGroupTwo: &armproviderhub.DefaultRolloutSpecificationRestOfTheWorldGroupTwo{
		// 																		Regions: []*string{
		// 																			to.Ptr("germanynorth"),
		// 																			to.Ptr("norwayeast"),
		// 																			to.Ptr("allotherregions")},
		// 																			WaitDuration: to.Ptr("PT4H"),
		// 																		},
		// 																	},
		// 																	Status: &armproviderhub.DefaultRolloutPropertiesStatus{
		// 																		CompletedRegions: []*string{
		// 																			to.Ptr("brazilus"),
		// 																			to.Ptr("eastus2euap"),
		// 																			to.Ptr("centraluseuap"),
		// 																			to.Ptr("allcompletedregions")},
		// 																			FailedOrSkippedRegions: map[string]*armproviderhub.ExtendedErrorInfo{
		// 																				"westus2": &armproviderhub.ExtendedErrorInfo{
		// 																					Code: to.Ptr("RolloutStoppedByUser"),
		// 																					Message: to.Ptr("Rollout was explicitly stopped by the user."),
		// 																				},
		// 																			},
		// 																		},
		// 																	},
		// 															}},
		// 														}
	}
}
Output:

func (*DefaultRolloutsClient) Stop

func (client *DefaultRolloutsClient) Stop(ctx context.Context, providerNamespace string, rolloutName string, options *DefaultRolloutsClientStopOptions) (DefaultRolloutsClientStopResponse, error)

Stop - Stops or cancels the rollout, if in progress. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • rolloutName - The rollout name.
  • options - DefaultRolloutsClientStopOptions contains the optional parameters for the DefaultRolloutsClient.Stop method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/DefaultRollouts_Stop.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewDefaultRolloutsClient().Stop(ctx, "Microsoft.Contoso", "2020week10", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

type DefaultRolloutsClientBeginCreateOrUpdateOptions added in v0.2.0

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

DefaultRolloutsClientBeginCreateOrUpdateOptions contains the optional parameters for the DefaultRolloutsClient.BeginCreateOrUpdate method.

type DefaultRolloutsClientCreateOrUpdateResponse added in v0.2.0

type DefaultRolloutsClientCreateOrUpdateResponse struct {
	// Default rollout definition.
	DefaultRollout
}

DefaultRolloutsClientCreateOrUpdateResponse contains the response from method DefaultRolloutsClient.BeginCreateOrUpdate.

type DefaultRolloutsClientDeleteOptions added in v0.2.0

type DefaultRolloutsClientDeleteOptions struct {
}

DefaultRolloutsClientDeleteOptions contains the optional parameters for the DefaultRolloutsClient.Delete method.

type DefaultRolloutsClientDeleteResponse added in v0.2.0

type DefaultRolloutsClientDeleteResponse struct {
}

DefaultRolloutsClientDeleteResponse contains the response from method DefaultRolloutsClient.Delete.

type DefaultRolloutsClientGetOptions added in v0.2.0

type DefaultRolloutsClientGetOptions struct {
}

DefaultRolloutsClientGetOptions contains the optional parameters for the DefaultRolloutsClient.Get method.

type DefaultRolloutsClientGetResponse added in v0.2.0

type DefaultRolloutsClientGetResponse struct {
	// Default rollout definition.
	DefaultRollout
}

DefaultRolloutsClientGetResponse contains the response from method DefaultRolloutsClient.Get.

type DefaultRolloutsClientListByProviderRegistrationOptions added in v0.2.0

type DefaultRolloutsClientListByProviderRegistrationOptions struct {
}

DefaultRolloutsClientListByProviderRegistrationOptions contains the optional parameters for the DefaultRolloutsClient.NewListByProviderRegistrationPager method.

type DefaultRolloutsClientListByProviderRegistrationResponse added in v0.2.0

type DefaultRolloutsClientListByProviderRegistrationResponse struct {
	DefaultRolloutArrayResponseWithContinuation
}

DefaultRolloutsClientListByProviderRegistrationResponse contains the response from method DefaultRolloutsClient.NewListByProviderRegistrationPager.

type DefaultRolloutsClientStopOptions added in v0.2.0

type DefaultRolloutsClientStopOptions struct {
}

DefaultRolloutsClientStopOptions contains the optional parameters for the DefaultRolloutsClient.Stop method.

type DefaultRolloutsClientStopResponse added in v0.2.0

type DefaultRolloutsClientStopResponse struct {
}

DefaultRolloutsClientStopResponse contains the response from method DefaultRolloutsClient.Stop.

type Error

type Error struct {
	// READ-ONLY; Server-defined set of error codes.
	Code *string

	// READ-ONLY; Array of details about specific errors that led to this reported error.
	Details []*Error

	// READ-ONLY; Object containing more specific information than the current object about the error.
	InnerError *ErrorInnerError

	// READ-ONLY; Human-readable representation of the error.
	Message *string

	// READ-ONLY; Target of the error.
	Target *string
}

Error - Standard error object.

func (Error) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type Error.

func (*Error) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type Error.

type ErrorInnerError

type ErrorInnerError struct {
	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

	// READ-ONLY; Specific error code than was provided by the containing error.
	Code *string

	// READ-ONLY; Object containing more specific information than the current object about the error.
	InnerError any
}

ErrorInnerError - Object containing more specific information than the current object about the error.

func (ErrorInnerError) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type ErrorInnerError.

func (*ErrorInnerError) UnmarshalJSON added in v0.2.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorInnerError.

type ErrorResponse

type ErrorResponse struct {
	// Standard error object.
	Error *ErrorResponseError
}

ErrorResponse - Standard error response.

func (ErrorResponse) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

func (*ErrorResponse) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponse.

type ErrorResponseError

type ErrorResponseError struct {
	// READ-ONLY; Server-defined set of error codes.
	Code *string

	// READ-ONLY; Array of details about specific errors that led to this reported error.
	Details []*Error

	// READ-ONLY; Object containing more specific information than the current object about the error.
	InnerError *ErrorInnerError

	// READ-ONLY; Human-readable representation of the error.
	Message *string

	// READ-ONLY; Target of the error.
	Target *string
}

ErrorResponseError - Standard error object.

func (ErrorResponseError) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type ErrorResponseError.

func (*ErrorResponseError) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponseError.

type ExtendedErrorInfo

type ExtendedErrorInfo struct {
	AdditionalInfo []*TypedErrorInfo
	Code           *string
	Details        []*ExtendedErrorInfo
	Message        *string
	Target         *string
}

func (ExtendedErrorInfo) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ExtendedErrorInfo.

func (*ExtendedErrorInfo) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type ExtendedErrorInfo.

type ExtendedLocationOptions

type ExtendedLocationOptions struct {
	SupportedPolicy *string
	Type            *string
}

func (ExtendedLocationOptions) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type ExtendedLocationOptions.

func (*ExtendedLocationOptions) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type ExtendedLocationOptions.

type ExtensionCategory

type ExtensionCategory string
const (
	ExtensionCategoryNotSpecified                      ExtensionCategory = "NotSpecified"
	ExtensionCategoryResourceCreationBegin             ExtensionCategory = "ResourceCreationBegin"
	ExtensionCategoryResourceCreationCompleted         ExtensionCategory = "ResourceCreationCompleted"
	ExtensionCategoryResourceCreationValidate          ExtensionCategory = "ResourceCreationValidate"
	ExtensionCategoryResourceDeletionBegin             ExtensionCategory = "ResourceDeletionBegin"
	ExtensionCategoryResourceDeletionCompleted         ExtensionCategory = "ResourceDeletionCompleted"
	ExtensionCategoryResourceDeletionValidate          ExtensionCategory = "ResourceDeletionValidate"
	ExtensionCategoryResourceMoveBegin                 ExtensionCategory = "ResourceMoveBegin"
	ExtensionCategoryResourceMoveCompleted             ExtensionCategory = "ResourceMoveCompleted"
	ExtensionCategoryResourcePatchBegin                ExtensionCategory = "ResourcePatchBegin"
	ExtensionCategoryResourcePatchCompleted            ExtensionCategory = "ResourcePatchCompleted"
	ExtensionCategoryResourcePatchValidate             ExtensionCategory = "ResourcePatchValidate"
	ExtensionCategoryResourcePostAction                ExtensionCategory = "ResourcePostAction"
	ExtensionCategoryResourceReadBegin                 ExtensionCategory = "ResourceReadBegin"
	ExtensionCategoryResourceReadValidate              ExtensionCategory = "ResourceReadValidate"
	ExtensionCategorySubscriptionLifecycleNotification ExtensionCategory = "SubscriptionLifecycleNotification"
)

func PossibleExtensionCategoryValues

func PossibleExtensionCategoryValues() []ExtensionCategory

PossibleExtensionCategoryValues returns the possible values for the ExtensionCategory const type.

type ExtensionOptionType

type ExtensionOptionType string
const (
	ExtensionOptionTypeDoNotMergeExistingReadOnlyAndSecretProperties ExtensionOptionType = "DoNotMergeExistingReadOnlyAndSecretProperties"
	ExtensionOptionTypeIncludeInternalMetadata                       ExtensionOptionType = "IncludeInternalMetadata"
	ExtensionOptionTypeNotSpecified                                  ExtensionOptionType = "NotSpecified"
)

func PossibleExtensionOptionTypeValues

func PossibleExtensionOptionTypeValues() []ExtensionOptionType

PossibleExtensionOptionTypeValues returns the possible values for the ExtensionOptionType const type.

type ExtensionOptions

type ExtensionOptions struct {
	Request  []*ExtensionOptionType
	Response []*ExtensionOptionType
}

func (ExtensionOptions) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ExtensionOptions.

func (*ExtensionOptions) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type ExtensionOptions.

type FeaturesPolicy

type FeaturesPolicy string
const (
	FeaturesPolicyAll FeaturesPolicy = "All"
	FeaturesPolicyAny FeaturesPolicy = "Any"
)

func PossibleFeaturesPolicyValues

func PossibleFeaturesPolicyValues() []FeaturesPolicy

PossibleFeaturesPolicyValues returns the possible values for the FeaturesPolicy const type.

type FeaturesRule

type FeaturesRule struct {
	// REQUIRED
	RequiredFeaturesPolicy *FeaturesPolicy
}

func (FeaturesRule) MarshalJSON added in v1.1.0

func (f FeaturesRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FeaturesRule.

func (*FeaturesRule) UnmarshalJSON added in v1.1.0

func (f *FeaturesRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FeaturesRule.

type IdentityManagement

type IdentityManagement struct {
	Type *IdentityManagementTypes
}

func (IdentityManagement) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type IdentityManagement.

func (*IdentityManagement) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type IdentityManagement.

type IdentityManagementProperties

type IdentityManagementProperties struct {
	ApplicationID *string
	Type          *IdentityManagementTypes
}

func (IdentityManagementProperties) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type IdentityManagementProperties.

func (*IdentityManagementProperties) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type IdentityManagementProperties.

type IdentityManagementTypes

type IdentityManagementTypes string
const (
	IdentityManagementTypesActor                     IdentityManagementTypes = "Actor"
	IdentityManagementTypesDelegatedResourceIdentity IdentityManagementTypes = "DelegatedResourceIdentity"
	IdentityManagementTypesNotSpecified              IdentityManagementTypes = "NotSpecified"
	IdentityManagementTypesSystemAssigned            IdentityManagementTypes = "SystemAssigned"
	IdentityManagementTypesUserAssigned              IdentityManagementTypes = "UserAssigned"
)

func PossibleIdentityManagementTypesValues

func PossibleIdentityManagementTypesValues() []IdentityManagementTypes

PossibleIdentityManagementTypesValues returns the possible values for the IdentityManagementTypes const type.

type InnerError

type InnerError struct {
	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

	// READ-ONLY; Specific error code than was provided by the containing error.
	Code *string

	// READ-ONLY; Object containing more specific information than the current object about the error.
	InnerError any
}

InnerError - Inner error containing list of errors.

func (InnerError) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type InnerError.

func (*InnerError) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type InnerError.

type LightHouseAuthorization

type LightHouseAuthorization struct {
	// REQUIRED
	PrincipalID *string

	// REQUIRED
	RoleDefinitionID *string
}

func (LightHouseAuthorization) MarshalJSON added in v1.1.0

func (l LightHouseAuthorization) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LightHouseAuthorization.

func (*LightHouseAuthorization) UnmarshalJSON added in v1.1.0

func (l *LightHouseAuthorization) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LightHouseAuthorization.

type LinkedAccessCheck

type LinkedAccessCheck struct {
	ActionName       *string
	LinkedAction     *string
	LinkedActionVerb *string
	LinkedProperty   *string
	LinkedType       *string
}

func (LinkedAccessCheck) MarshalJSON added in v1.1.0

func (l LinkedAccessCheck) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LinkedAccessCheck.

func (*LinkedAccessCheck) UnmarshalJSON added in v1.1.0

func (l *LinkedAccessCheck) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LinkedAccessCheck.

type LinkedAction

type LinkedAction string
const (
	LinkedActionBlocked      LinkedAction = "Blocked"
	LinkedActionEnabled      LinkedAction = "Enabled"
	LinkedActionNotSpecified LinkedAction = "NotSpecified"
	LinkedActionValidate     LinkedAction = "Validate"
)

func PossibleLinkedActionValues

func PossibleLinkedActionValues() []LinkedAction

PossibleLinkedActionValues returns the possible values for the LinkedAction const type.

type LinkedOperation

type LinkedOperation string
const (
	LinkedOperationCrossResourceGroupResourceMove LinkedOperation = "CrossResourceGroupResourceMove"
	LinkedOperationCrossSubscriptionResourceMove  LinkedOperation = "CrossSubscriptionResourceMove"
	LinkedOperationNone                           LinkedOperation = "None"
)

func PossibleLinkedOperationValues

func PossibleLinkedOperationValues() []LinkedOperation

PossibleLinkedOperationValues returns the possible values for the LinkedOperation const type.

type LinkedOperationRule

type LinkedOperationRule struct {
	// REQUIRED
	LinkedAction *LinkedAction

	// REQUIRED
	LinkedOperation *LinkedOperation
}

func (LinkedOperationRule) MarshalJSON added in v1.1.0

func (l LinkedOperationRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LinkedOperationRule.

func (*LinkedOperationRule) UnmarshalJSON added in v1.1.0

func (l *LinkedOperationRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LinkedOperationRule.

type LoggingDetails

type LoggingDetails string
const (
	LoggingDetailsBody LoggingDetails = "Body"
	LoggingDetailsNone LoggingDetails = "None"
)

func PossibleLoggingDetailsValues

func PossibleLoggingDetailsValues() []LoggingDetails

PossibleLoggingDetailsValues returns the possible values for the LoggingDetails const type.

type LoggingDirections

type LoggingDirections string
const (
	LoggingDirectionsNone     LoggingDirections = "None"
	LoggingDirectionsRequest  LoggingDirections = "Request"
	LoggingDirectionsResponse LoggingDirections = "Response"
)

func PossibleLoggingDirectionsValues

func PossibleLoggingDirectionsValues() []LoggingDirections

PossibleLoggingDirectionsValues returns the possible values for the LoggingDirections const type.

type LoggingHiddenPropertyPath

type LoggingHiddenPropertyPath struct {
	HiddenPathsOnRequest  []*string
	HiddenPathsOnResponse []*string
}

func (LoggingHiddenPropertyPath) MarshalJSON

func (l LoggingHiddenPropertyPath) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoggingHiddenPropertyPath.

func (*LoggingHiddenPropertyPath) UnmarshalJSON added in v1.1.0

func (l *LoggingHiddenPropertyPath) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LoggingHiddenPropertyPath.

type LoggingRule

type LoggingRule struct {
	// REQUIRED
	Action *string

	// REQUIRED
	DetailLevel *LoggingDetails

	// REQUIRED
	Direction           *LoggingDirections
	HiddenPropertyPaths *LoggingRuleHiddenPropertyPaths
}

func (LoggingRule) MarshalJSON added in v1.1.0

func (l LoggingRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoggingRule.

func (*LoggingRule) UnmarshalJSON added in v1.1.0

func (l *LoggingRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LoggingRule.

type LoggingRuleHiddenPropertyPaths

type LoggingRuleHiddenPropertyPaths struct {
	HiddenPathsOnRequest  []*string
	HiddenPathsOnResponse []*string
}

func (LoggingRuleHiddenPropertyPaths) MarshalJSON added in v0.2.0

func (l LoggingRuleHiddenPropertyPaths) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoggingRuleHiddenPropertyPaths.

func (*LoggingRuleHiddenPropertyPaths) UnmarshalJSON added in v1.1.0

func (l *LoggingRuleHiddenPropertyPaths) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LoggingRuleHiddenPropertyPaths.

type ManifestResourceDeletionPolicy

type ManifestResourceDeletionPolicy string
const (
	ManifestResourceDeletionPolicyCascade      ManifestResourceDeletionPolicy = "Cascade"
	ManifestResourceDeletionPolicyForce        ManifestResourceDeletionPolicy = "Force"
	ManifestResourceDeletionPolicyNotSpecified ManifestResourceDeletionPolicy = "NotSpecified"
)

func PossibleManifestResourceDeletionPolicyValues

func PossibleManifestResourceDeletionPolicyValues() []ManifestResourceDeletionPolicy

PossibleManifestResourceDeletionPolicyValues returns the possible values for the ManifestResourceDeletionPolicy const type.

type MessageScope

type MessageScope string
const (
	MessageScopeNotSpecified            MessageScope = "NotSpecified"
	MessageScopeRegisteredSubscriptions MessageScope = "RegisteredSubscriptions"
)

func PossibleMessageScopeValues

func PossibleMessageScopeValues() []MessageScope

PossibleMessageScopeValues returns the possible values for the MessageScope const type.

type Metadata added in v0.2.0

type Metadata struct {
	ProviderAuthentication          *MetadataProviderAuthentication
	ProviderAuthorizations          []*ResourceProviderAuthorization
	ThirdPartyProviderAuthorization *MetadataThirdPartyProviderAuthorization
}

func (Metadata) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type Metadata.

func (*Metadata) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type Metadata.

type MetadataProviderAuthentication added in v0.2.0

type MetadataProviderAuthentication struct {
	// REQUIRED
	AllowedAudiences []*string
}

func (MetadataProviderAuthentication) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type MetadataProviderAuthentication.

func (*MetadataProviderAuthentication) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type MetadataProviderAuthentication.

type MetadataThirdPartyProviderAuthorization added in v0.2.0

type MetadataThirdPartyProviderAuthorization struct {
	Authorizations    []*LightHouseAuthorization
	ManagedByTenantID *string
}

func (MetadataThirdPartyProviderAuthorization) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type MetadataThirdPartyProviderAuthorization.

func (*MetadataThirdPartyProviderAuthorization) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type MetadataThirdPartyProviderAuthorization.

type NotificationEndpoint

type NotificationEndpoint struct {
	Locations               []*string
	NotificationDestination *string
}

func (NotificationEndpoint) MarshalJSON

func (n NotificationEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NotificationEndpoint.

func (*NotificationEndpoint) UnmarshalJSON added in v1.1.0

func (n *NotificationEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NotificationEndpoint.

type NotificationMode

type NotificationMode string
const (
	NotificationModeEventHub     NotificationMode = "EventHub"
	NotificationModeNotSpecified NotificationMode = "NotSpecified"
	NotificationModeWebHook      NotificationMode = "WebHook"
)

func PossibleNotificationModeValues

func PossibleNotificationModeValues() []NotificationMode

PossibleNotificationModeValues returns the possible values for the NotificationMode const type.

type NotificationRegistration

type NotificationRegistration struct {
	Properties *NotificationRegistrationProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

NotificationRegistration - The notification registration definition.

func (NotificationRegistration) MarshalJSON added in v1.1.0

func (n NotificationRegistration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NotificationRegistration.

func (*NotificationRegistration) UnmarshalJSON added in v1.1.0

func (n *NotificationRegistration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NotificationRegistration.

type NotificationRegistrationArrayResponseWithContinuation

type NotificationRegistrationArrayResponseWithContinuation struct {
	// The URL to get to the next set of results, if there are any.
	NextLink *string
	Value    []*NotificationRegistration
}

func (NotificationRegistrationArrayResponseWithContinuation) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type NotificationRegistrationArrayResponseWithContinuation.

func (*NotificationRegistrationArrayResponseWithContinuation) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type NotificationRegistrationArrayResponseWithContinuation.

type NotificationRegistrationProperties

type NotificationRegistrationProperties struct {
	IncludedEvents        []*string
	MessageScope          *MessageScope
	NotificationEndpoints []*NotificationEndpoint
	NotificationMode      *NotificationMode
	ProvisioningState     *ProvisioningState
}

func (NotificationRegistrationProperties) MarshalJSON added in v0.2.0

func (n NotificationRegistrationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NotificationRegistrationProperties.

func (*NotificationRegistrationProperties) UnmarshalJSON added in v1.1.0

func (n *NotificationRegistrationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NotificationRegistrationProperties.

type NotificationRegistrationPropertiesAutoGenerated

type NotificationRegistrationPropertiesAutoGenerated struct {
	IncludedEvents        []*string
	MessageScope          *MessageScope
	NotificationEndpoints []*NotificationEndpoint
	NotificationMode      *NotificationMode
	ProvisioningState     *ProvisioningState
}

func (NotificationRegistrationPropertiesAutoGenerated) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type NotificationRegistrationPropertiesAutoGenerated.

func (*NotificationRegistrationPropertiesAutoGenerated) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type NotificationRegistrationPropertiesAutoGenerated.

type NotificationRegistrationsClient

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

NotificationRegistrationsClient contains the methods for the NotificationRegistrations group. Don't use this type directly, use NewNotificationRegistrationsClient() instead.

func NewNotificationRegistrationsClient

func NewNotificationRegistrationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*NotificationRegistrationsClient, error)

NewNotificationRegistrationsClient creates a new instance of NotificationRegistrationsClient with the specified values.

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

func (*NotificationRegistrationsClient) CreateOrUpdate

CreateOrUpdate - Creates or updates a notification registration. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • notificationRegistrationName - The notification registration.
  • properties - The required body parameters supplied to the notification registration operation.
  • options - NotificationRegistrationsClientCreateOrUpdateOptions contains the optional parameters for the NotificationRegistrationsClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/NotificationRegistrations_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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewNotificationRegistrationsClient().CreateOrUpdate(ctx, "Microsoft.Contoso", "fooNotificationRegistration", armproviderhub.NotificationRegistration{
		Properties: &armproviderhub.NotificationRegistrationProperties{
			IncludedEvents: []*string{
				to.Ptr("*/write"),
				to.Ptr("Microsoft.Contoso/employees/delete")},
			MessageScope: to.Ptr(armproviderhub.MessageScopeRegisteredSubscriptions),
			NotificationEndpoints: []*armproviderhub.NotificationEndpoint{
				{
					Locations: []*string{
						to.Ptr(""),
						to.Ptr("East US")},
					NotificationDestination: to.Ptr("/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications"),
				},
				{
					Locations: []*string{
						to.Ptr("North Europe")},
					NotificationDestination: to.Ptr("/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-northeurope/providers/Microsoft.EventHub/namespaces/europe-mgmtexpint/eventhubs/armlinkednotifications"),
				}},
			NotificationMode: to.Ptr(armproviderhub.NotificationModeEventHub),
		},
	}, 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.NotificationRegistration = armproviderhub.NotificationRegistration{
	// 	Name: to.Ptr("fooNotificationRegistration"),
	// 	Type: to.Ptr("Microsoft.ProviderHub/providerRegistrations/notificationregistrations"),
	// 	ID: to.Ptr("/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/notificationregistrations/fooNotificationRegistration"),
	// 	Properties: &armproviderhub.NotificationRegistrationProperties{
	// 		IncludedEvents: []*string{
	// 			to.Ptr("*/write"),
	// 			to.Ptr("Microsoft.Contoso/employees/delete")},
	// 			MessageScope: to.Ptr(armproviderhub.MessageScopeRegisteredSubscriptions),
	// 			NotificationEndpoints: []*armproviderhub.NotificationEndpoint{
	// 				{
	// 					Locations: []*string{
	// 						to.Ptr(""),
	// 						to.Ptr("East US")},
	// 						NotificationDestination: to.Ptr("/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications"),
	// 					},
	// 					{
	// 						Locations: []*string{
	// 							to.Ptr("North Europe")},
	// 							NotificationDestination: to.Ptr("/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-northeurope/providers/Microsoft.EventHub/namespaces/europe-mgmtexpint/eventhubs/armlinkednotifications"),
	// 					}},
	// 					NotificationMode: to.Ptr(armproviderhub.NotificationModeEventHub),
	// 				},
	// 			}
}
Output:

func (*NotificationRegistrationsClient) Delete

Delete - Deletes a notification registration. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • notificationRegistrationName - The notification registration.
  • options - NotificationRegistrationsClientDeleteOptions contains the optional parameters for the NotificationRegistrationsClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/NotificationRegistrations_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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewNotificationRegistrationsClient().Delete(ctx, "Microsoft.Contoso", "fooNotificationRegistration", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*NotificationRegistrationsClient) Get

Get - Gets the notification registration details. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • notificationRegistrationName - The notification registration.
  • options - NotificationRegistrationsClientGetOptions contains the optional parameters for the NotificationRegistrationsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/NotificationRegistrations_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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewNotificationRegistrationsClient().Get(ctx, "Microsoft.Contoso", "fooNotificationRegistration", 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.NotificationRegistration = armproviderhub.NotificationRegistration{
	// 	Name: to.Ptr("fooNotificationRegistration"),
	// 	Type: to.Ptr("Microsoft.ProviderHub/providerRegistrations/notificationregistrations"),
	// 	ID: to.Ptr("/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/notificationregistrations/fooNotificationRegistration"),
	// 	Properties: &armproviderhub.NotificationRegistrationProperties{
	// 		IncludedEvents: []*string{
	// 			to.Ptr("*/write"),
	// 			to.Ptr("Microsoft.Contoso/employees/delete")},
	// 			MessageScope: to.Ptr(armproviderhub.MessageScopeRegisteredSubscriptions),
	// 			NotificationEndpoints: []*armproviderhub.NotificationEndpoint{
	// 				{
	// 					Locations: []*string{
	// 						to.Ptr(""),
	// 						to.Ptr("East US")},
	// 						NotificationDestination: to.Ptr("/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications"),
	// 					},
	// 					{
	// 						Locations: []*string{
	// 							to.Ptr("North Europe")},
	// 							NotificationDestination: to.Ptr("/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-northeurope/providers/Microsoft.EventHub/namespaces/europe-mgmtexpint/eventhubs/armlinkednotifications"),
	// 					}},
	// 					NotificationMode: to.Ptr(armproviderhub.NotificationModeEventHub),
	// 				},
	// 			}
}
Output:

func (*NotificationRegistrationsClient) NewListByProviderRegistrationPager added in v0.4.0

NewListByProviderRegistrationPager - Gets the list of the notification registrations for the given provider.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • options - NotificationRegistrationsClientListByProviderRegistrationOptions contains the optional parameters for the NotificationRegistrationsClient.NewListByProviderRegistrationPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/NotificationRegistrations_ListByProviderRegistration.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewNotificationRegistrationsClient().NewListByProviderRegistrationPager("Microsoft.Contoso", 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.NotificationRegistrationArrayResponseWithContinuation = armproviderhub.NotificationRegistrationArrayResponseWithContinuation{
		// 	Value: []*armproviderhub.NotificationRegistration{
		// 		{
		// 			Name: to.Ptr("fooNotificationRegistration"),
		// 			Properties: &armproviderhub.NotificationRegistrationProperties{
		// 				IncludedEvents: []*string{
		// 					to.Ptr("*/write"),
		// 					to.Ptr("Microsoft.Contoso/employees/delete")},
		// 					MessageScope: to.Ptr(armproviderhub.MessageScopeRegisteredSubscriptions),
		// 					NotificationEndpoints: []*armproviderhub.NotificationEndpoint{
		// 						{
		// 							Locations: []*string{
		// 								to.Ptr(""),
		// 								to.Ptr("East US")},
		// 								NotificationDestination: to.Ptr("/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications"),
		// 							},
		// 							{
		// 								Locations: []*string{
		// 									to.Ptr("North Europe")},
		// 									NotificationDestination: to.Ptr("/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-northeurope/providers/Microsoft.EventHub/namespaces/europe-mgmtexpint/eventhubs/armlinkednotifications"),
		// 							}},
		// 							NotificationMode: to.Ptr(armproviderhub.NotificationModeEventHub),
		// 						},
		// 					},
		// 					{
		// 						Name: to.Ptr("barNotificationRegistration"),
		// 						Properties: &armproviderhub.NotificationRegistrationProperties{
		// 							IncludedEvents: []*string{
		// 								to.Ptr("*/delete")},
		// 								MessageScope: to.Ptr(armproviderhub.MessageScopeRegisteredSubscriptions),
		// 								NotificationEndpoints: []*armproviderhub.NotificationEndpoint{
		// 									{
		// 										Locations: []*string{
		// 											to.Ptr("")},
		// 											NotificationDestination: to.Ptr("/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications"),
		// 									}},
		// 									NotificationMode: to.Ptr(armproviderhub.NotificationModeEventHub),
		// 								},
		// 						}},
		// 					}
	}
}
Output:

type NotificationRegistrationsClientCreateOrUpdateOptions added in v0.2.0

type NotificationRegistrationsClientCreateOrUpdateOptions struct {
}

NotificationRegistrationsClientCreateOrUpdateOptions contains the optional parameters for the NotificationRegistrationsClient.CreateOrUpdate method.

type NotificationRegistrationsClientCreateOrUpdateResponse added in v0.2.0

type NotificationRegistrationsClientCreateOrUpdateResponse struct {
	// The notification registration definition.
	NotificationRegistration
}

NotificationRegistrationsClientCreateOrUpdateResponse contains the response from method NotificationRegistrationsClient.CreateOrUpdate.

type NotificationRegistrationsClientDeleteOptions added in v0.2.0

type NotificationRegistrationsClientDeleteOptions struct {
}

NotificationRegistrationsClientDeleteOptions contains the optional parameters for the NotificationRegistrationsClient.Delete method.

type NotificationRegistrationsClientDeleteResponse added in v0.2.0

type NotificationRegistrationsClientDeleteResponse struct {
}

NotificationRegistrationsClientDeleteResponse contains the response from method NotificationRegistrationsClient.Delete.

type NotificationRegistrationsClientGetOptions added in v0.2.0

type NotificationRegistrationsClientGetOptions struct {
}

NotificationRegistrationsClientGetOptions contains the optional parameters for the NotificationRegistrationsClient.Get method.

type NotificationRegistrationsClientGetResponse added in v0.2.0

type NotificationRegistrationsClientGetResponse struct {
	// The notification registration definition.
	NotificationRegistration
}

NotificationRegistrationsClientGetResponse contains the response from method NotificationRegistrationsClient.Get.

type NotificationRegistrationsClientListByProviderRegistrationOptions added in v0.2.0

type NotificationRegistrationsClientListByProviderRegistrationOptions struct {
}

NotificationRegistrationsClientListByProviderRegistrationOptions contains the optional parameters for the NotificationRegistrationsClient.NewListByProviderRegistrationPager method.

type NotificationRegistrationsClientListByProviderRegistrationResponse added in v0.2.0

type NotificationRegistrationsClientListByProviderRegistrationResponse struct {
	NotificationRegistrationArrayResponseWithContinuation
}

NotificationRegistrationsClientListByProviderRegistrationResponse contains the response from method NotificationRegistrationsClient.NewListByProviderRegistrationPager.

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(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values.

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

func (*OperationsClient) CreateOrUpdate

func (client *OperationsClient) CreateOrUpdate(ctx context.Context, providerNamespace string, operationsPutContent OperationsPutContent, options *OperationsClientCreateOrUpdateOptions) (OperationsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates the operation supported by the given provider. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • operationsPutContent - The operations content properties supplied to the CreateOrUpdate operation.
  • options - OperationsClientCreateOrUpdateOptions contains the optional parameters for the OperationsClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Operations_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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewOperationsClient().CreateOrUpdate(ctx, "Microsoft.Contoso", armproviderhub.OperationsPutContent{
		Contents: []*armproviderhub.OperationsDefinition{
			{
				Name: to.Ptr("Microsoft.Contoso/Employees/Read"),
				Display: &armproviderhub.OperationsDefinitionDisplay{
					Description: to.Ptr("Read employees"),
					Operation:   to.Ptr("Gets/List employee resources"),
					Provider:    to.Ptr("Microsoft.Contoso"),
					Resource:    to.Ptr("Employees"),
				},
			}},
	}, 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.OperationsContent = armproviderhub.OperationsContent{
	// 	Properties: &armproviderhub.OperationsDefinition{
	// 		Name: to.Ptr("Microsoft.Contoso/Employees/Read"),
	// 		Display: &armproviderhub.OperationsDefinitionDisplay{
	// 			Description: to.Ptr("Read employees"),
	// 			Operation: to.Ptr("Gets/List employee resources"),
	// 			Provider: to.Ptr("Microsoft.Contoso"),
	// 			Resource: to.Ptr("Employees"),
	// 		},
	// 	},
	// }
}
Output:

func (*OperationsClient) Delete

func (client *OperationsClient) Delete(ctx context.Context, providerNamespace string, options *OperationsClientDeleteOptions) (OperationsClientDeleteResponse, error)

Delete - Deletes an operation. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • options - OperationsClientDeleteOptions contains the optional parameters for the OperationsClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Operations_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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewOperationsClient().Delete(ctx, "Microsoft.Contoso", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*OperationsClient) ListByProviderRegistration

ListByProviderRegistration - Gets the operations supported by the given provider. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • options - OperationsClientListByProviderRegistrationOptions contains the optional parameters for the OperationsClient.ListByProviderRegistration method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Operations_ListByProviderRegistration.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewOperationsClient().ListByProviderRegistration(ctx, "Microsoft.Contoso", 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.OperationsDefinitionArray = []*armproviderhub.OperationsDefinition{
	// 	{
	// 		Name: to.Ptr("Microsoft.Contoso/Employees/Read"),
	// 		Display: &armproviderhub.OperationsDefinitionDisplay{
	// 			Description: to.Ptr("Read employees"),
	// 			Operation: to.Ptr("Gets/List employee resources"),
	// 			Provider: to.Ptr("Microsoft.Contoso"),
	// 			Resource: to.Ptr("Employees"),
	// 		},
	// 		IsDataAction: to.Ptr(false),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Contoso/Employees/Write"),
	// 		Display: &armproviderhub.OperationsDefinitionDisplay{
	// 			Description: to.Ptr("Writes employees"),
	// 			Operation: to.Ptr("Create/update employee resources"),
	// 			Provider: to.Ptr("Microsoft.Contoso"),
	// 			Resource: to.Ptr("Employees"),
	// 		},
	// 		IsDataAction: to.Ptr(false),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Contoso/Employees/Delete"),
	// 		Display: &armproviderhub.OperationsDefinitionDisplay{
	// 			Description: to.Ptr("Deletes employees"),
	// 			Operation: to.Ptr("Deletes employee resource"),
	// 			Provider: to.Ptr("Microsoft.Contoso"),
	// 			Resource: to.Ptr("Employees"),
	// 		},
	// 		IsDataAction: to.Ptr(false),
	// 		Origin: to.Ptr(armproviderhub.OperationsDefinitionOriginUser),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Contoso/Employees/Action"),
	// 		Display: &armproviderhub.OperationsDefinitionDisplay{
	// 			Description: to.Ptr("Writes employees"),
	// 			Operation: to.Ptr("Create/update employee resources"),
	// 			Provider: to.Ptr("Microsoft.Contoso"),
	// 			Resource: to.Ptr("Employees"),
	// 		},
	// 		IsDataAction: to.Ptr(true),
	// 		Origin: to.Ptr(armproviderhub.OperationsDefinitionOriginSystem),
	// }}
}
Output:

func (*OperationsClient) NewListPager added in v0.4.0

NewListPager - Lists all the operations supported by Microsoft.ProviderHub.

Generated from API version 2020-11-20

  • 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/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.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.OperationsDefinitionArrayResponseWithContinuation = armproviderhub.OperationsDefinitionArrayResponseWithContinuation{
		// 	Value: []*armproviderhub.OperationsDefinition{
		// 		{
		// 			Name: to.Ptr("Microsoft.ProviderHub/register/action"),
		// 			Display: &armproviderhub.OperationsDefinitionDisplay{
		// 				Description: to.Ptr("Registers the specified subscription with Microsoft.ProviderHub resource provider"),
		// 				Operation: to.Ptr("Register for Microsoft.ProviderHub"),
		// 				Provider: to.Ptr("Microsoft ProviderHub"),
		// 				Resource: to.Ptr("register"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.ProviderHub/defaultRollouts/write"),
		// 			Display: &armproviderhub.OperationsDefinitionDisplay{
		// 				Description: to.Ptr("Creates or Updates any rollout"),
		// 				Operation: to.Ptr("Create or Update rollout"),
		// 				Provider: to.Ptr("Microsoft ProviderHub"),
		// 				Resource: to.Ptr("defaultRollouts"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.ProviderHub/defaultRollouts/read"),
		// 			Display: &armproviderhub.OperationsDefinitionDisplay{
		// 				Description: to.Ptr("Reads any rollout"),
		// 				Operation: to.Ptr("Read rollout"),
		// 				Provider: to.Ptr("Microsoft ProviderHub"),
		// 				Resource: to.Ptr("defaultRollouts"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.ProviderHub/defaultRollouts/delete"),
		// 			Display: &armproviderhub.OperationsDefinitionDisplay{
		// 				Description: to.Ptr("Deletes any rollout"),
		// 				Operation: to.Ptr("Delete rollout"),
		// 				Provider: to.Ptr("Microsoft ProviderHub"),
		// 				Resource: to.Ptr("defaultRollouts"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.ProviderHub/defaultRollouts/stop/action"),
		// 			Display: &armproviderhub.OperationsDefinitionDisplay{
		// 				Description: to.Ptr("Deletes any rollout"),
		// 				Operation: to.Ptr("Delete rollout"),
		// 				Provider: to.Ptr("Microsoft ProviderHub"),
		// 				Resource: to.Ptr("defaultRollouts"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.ProviderHub/customRollouts/write"),
		// 			Display: &armproviderhub.OperationsDefinitionDisplay{
		// 				Description: to.Ptr("Creates or Updates any rollout"),
		// 				Operation: to.Ptr("Create or Update rollout"),
		// 				Provider: to.Ptr("Microsoft ProviderHub"),
		// 				Resource: to.Ptr("customRollouts"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.ProviderHub/customRollouts/read"),
		// 			Display: &armproviderhub.OperationsDefinitionDisplay{
		// 				Description: to.Ptr("Reads any rollout"),
		// 				Operation: to.Ptr("Read rollout"),
		// 				Provider: to.Ptr("Microsoft ProviderHub"),
		// 				Resource: to.Ptr("customRollouts"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 	}},
		// }
	}
}
Output:

type OperationsClientCreateOrUpdateOptions added in v0.2.0

type OperationsClientCreateOrUpdateOptions struct {
}

OperationsClientCreateOrUpdateOptions contains the optional parameters for the OperationsClient.CreateOrUpdate method.

type OperationsClientCreateOrUpdateResponse added in v0.2.0

type OperationsClientCreateOrUpdateResponse struct {
	OperationsContent
}

OperationsClientCreateOrUpdateResponse contains the response from method OperationsClient.CreateOrUpdate.

type OperationsClientDeleteOptions added in v0.2.0

type OperationsClientDeleteOptions struct {
}

OperationsClientDeleteOptions contains the optional parameters for the OperationsClient.Delete method.

type OperationsClientDeleteResponse added in v0.2.0

type OperationsClientDeleteResponse struct {
}

OperationsClientDeleteResponse contains the response from method OperationsClient.Delete.

type OperationsClientListByProviderRegistrationOptions added in v0.2.0

type OperationsClientListByProviderRegistrationOptions struct {
}

OperationsClientListByProviderRegistrationOptions contains the optional parameters for the OperationsClient.ListByProviderRegistration method.

type OperationsClientListByProviderRegistrationResponse added in v0.2.0

type OperationsClientListByProviderRegistrationResponse struct {
	// Array of OperationsDefinition
	OperationsDefinitionArray []*OperationsDefinition
}

OperationsClientListByProviderRegistrationResponse contains the response from method OperationsClient.ListByProviderRegistration.

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 {
	OperationsDefinitionArrayResponseWithContinuation
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager.

type OperationsContent

type OperationsContent struct {
	// Operations content.
	Properties *OperationsDefinition

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

func (OperationsContent) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type OperationsContent.

func (*OperationsContent) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type OperationsContent.

type OperationsDefinition

type OperationsDefinition struct {
	// REQUIRED; Display information of the operation.
	Display *OperationsDefinitionDisplay

	// REQUIRED; Name of the operation.
	Name       *string
	ActionType *OperationsDefinitionActionType

	// Indicates whether the operation applies to data-plane.
	IsDataAction *bool
	Origin       *OperationsDefinitionOrigin

	// Anything
	Properties any
}

OperationsDefinition - Properties of an Operation.

func (OperationsDefinition) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type OperationsDefinition.

func (*OperationsDefinition) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type OperationsDefinition.

type OperationsDefinitionActionType

type OperationsDefinitionActionType string
const (
	OperationsDefinitionActionTypeInternal     OperationsDefinitionActionType = "Internal"
	OperationsDefinitionActionTypeNotSpecified OperationsDefinitionActionType = "NotSpecified"
)

func PossibleOperationsDefinitionActionTypeValues

func PossibleOperationsDefinitionActionTypeValues() []OperationsDefinitionActionType

PossibleOperationsDefinitionActionTypeValues returns the possible values for the OperationsDefinitionActionType const type.

type OperationsDefinitionArrayResponseWithContinuation

type OperationsDefinitionArrayResponseWithContinuation struct {
	// The URL to get to the next set of results, if there are any.
	NextLink *string
	Value    []*OperationsDefinition
}

func (OperationsDefinitionArrayResponseWithContinuation) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type OperationsDefinitionArrayResponseWithContinuation.

func (*OperationsDefinitionArrayResponseWithContinuation) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type OperationsDefinitionArrayResponseWithContinuation.

type OperationsDefinitionDisplay

type OperationsDefinitionDisplay struct {
	// REQUIRED
	Description *string

	// REQUIRED
	Operation *string

	// REQUIRED
	Provider *string

	// REQUIRED
	Resource *string
}

OperationsDefinitionDisplay - Display information of the operation.

func (OperationsDefinitionDisplay) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type OperationsDefinitionDisplay.

func (*OperationsDefinitionDisplay) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type OperationsDefinitionDisplay.

type OperationsDefinitionOrigin

type OperationsDefinitionOrigin string
const (
	OperationsDefinitionOriginNotSpecified OperationsDefinitionOrigin = "NotSpecified"
	OperationsDefinitionOriginSystem       OperationsDefinitionOrigin = "System"
	OperationsDefinitionOriginUser         OperationsDefinitionOrigin = "User"
)

func PossibleOperationsDefinitionOriginValues

func PossibleOperationsDefinitionOriginValues() []OperationsDefinitionOrigin

PossibleOperationsDefinitionOriginValues returns the possible values for the OperationsDefinitionOrigin const type.

type OperationsDisplayDefinition

type OperationsDisplayDefinition struct {
	// REQUIRED
	Description *string

	// REQUIRED
	Operation *string

	// REQUIRED
	Provider *string

	// REQUIRED
	Resource *string
}

func (OperationsDisplayDefinition) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type OperationsDisplayDefinition.

func (*OperationsDisplayDefinition) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type OperationsDisplayDefinition.

type OperationsPutContent

type OperationsPutContent struct {
	// REQUIRED
	Contents []*OperationsDefinition
}

func (OperationsPutContent) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type OperationsPutContent.

func (*OperationsPutContent) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type OperationsPutContent.

type OptInHeaderType

type OptInHeaderType string
const (
	OptInHeaderTypeClientGroupMembership          OptInHeaderType = "ClientGroupMembership"
	OptInHeaderTypeNotSpecified                   OptInHeaderType = "NotSpecified"
	OptInHeaderTypeSignedAuxiliaryTokens          OptInHeaderType = "SignedAuxiliaryTokens"
	OptInHeaderTypeSignedUserToken                OptInHeaderType = "SignedUserToken"
	OptInHeaderTypeUnboundedClientGroupMembership OptInHeaderType = "UnboundedClientGroupMembership"
)

func PossibleOptInHeaderTypeValues

func PossibleOptInHeaderTypeValues() []OptInHeaderType

PossibleOptInHeaderTypeValues returns the possible values for the OptInHeaderType const type.

type PreflightOption

type PreflightOption string
const (
	PreflightOptionContinueDeploymentOnFailure PreflightOption = "ContinueDeploymentOnFailure"
	PreflightOptionDefaultValidationOnly       PreflightOption = "DefaultValidationOnly"
	PreflightOptionNone                        PreflightOption = "None"
)

func PossiblePreflightOptionValues

func PossiblePreflightOptionValues() []PreflightOption

PossiblePreflightOptionValues returns the possible values for the PreflightOption const type.

type ProviderRegistration

type ProviderRegistration struct {
	Properties *ProviderRegistrationProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

func (ProviderRegistration) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type ProviderRegistration.

func (*ProviderRegistration) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type ProviderRegistration.

type ProviderRegistrationArrayResponseWithContinuation

type ProviderRegistrationArrayResponseWithContinuation struct {
	// The URL to get to the next set of results, if there are any.
	NextLink *string
	Value    []*ProviderRegistration
}

func (ProviderRegistrationArrayResponseWithContinuation) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ProviderRegistrationArrayResponseWithContinuation.

func (*ProviderRegistrationArrayResponseWithContinuation) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type ProviderRegistrationArrayResponseWithContinuation.

type ProviderRegistrationProperties

type ProviderRegistrationProperties struct {
	Capabilities []*ResourceProviderCapabilities
	FeaturesRule *ResourceProviderManifestPropertiesFeaturesRule
	Management   *ResourceProviderManifestPropertiesManagement

	// Anything
	Metadata                                        any
	Namespace                                       *string
	ProviderAuthentication                          *ResourceProviderManifestPropertiesProviderAuthentication
	ProviderAuthorizations                          []*ResourceProviderAuthorization
	ProviderHubMetadata                             *ProviderRegistrationPropertiesProviderHubMetadata
	ProviderType                                    *ResourceProviderType
	ProviderVersion                                 *string
	ProvisioningState                               *ProvisioningState
	RequestHeaderOptions                            *ResourceProviderManifestPropertiesRequestHeaderOptions
	RequiredFeatures                                []*string
	SubscriptionLifecycleNotificationSpecifications *ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications
	TemplateDeploymentOptions                       *ResourceProviderManifestPropertiesTemplateDeploymentOptions
}

func (ProviderRegistrationProperties) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type ProviderRegistrationProperties.

func (*ProviderRegistrationProperties) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type ProviderRegistrationProperties.

type ProviderRegistrationPropertiesAutoGenerated

type ProviderRegistrationPropertiesAutoGenerated struct {
	Capabilities []*ResourceProviderCapabilities
	FeaturesRule *ResourceProviderManifestPropertiesFeaturesRule
	Management   *ResourceProviderManifestPropertiesManagement

	// Anything
	Metadata                                        any
	Namespace                                       *string
	ProviderAuthentication                          *ResourceProviderManifestPropertiesProviderAuthentication
	ProviderAuthorizations                          []*ResourceProviderAuthorization
	ProviderHubMetadata                             *ProviderRegistrationPropertiesProviderHubMetadata
	ProviderType                                    *ResourceProviderType
	ProviderVersion                                 *string
	ProvisioningState                               *ProvisioningState
	RequestHeaderOptions                            *ResourceProviderManifestPropertiesRequestHeaderOptions
	RequiredFeatures                                []*string
	SubscriptionLifecycleNotificationSpecifications *ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications
	TemplateDeploymentOptions                       *ResourceProviderManifestPropertiesTemplateDeploymentOptions
}

func (ProviderRegistrationPropertiesAutoGenerated) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ProviderRegistrationPropertiesAutoGenerated.

func (*ProviderRegistrationPropertiesAutoGenerated) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type ProviderRegistrationPropertiesAutoGenerated.

type ProviderRegistrationPropertiesProviderHubMetadata

type ProviderRegistrationPropertiesProviderHubMetadata struct {
	ProviderAuthentication          *MetadataProviderAuthentication
	ProviderAuthorizations          []*ResourceProviderAuthorization
	ThirdPartyProviderAuthorization *MetadataThirdPartyProviderAuthorization
}

func (ProviderRegistrationPropertiesProviderHubMetadata) MarshalJSON added in v0.2.0

MarshalJSON implements the json.Marshaller interface for type ProviderRegistrationPropertiesProviderHubMetadata.

func (*ProviderRegistrationPropertiesProviderHubMetadata) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type ProviderRegistrationPropertiesProviderHubMetadata.

type ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications

type ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications struct {
	SoftDeleteTTL                    *string
	SubscriptionStateOverrideActions []*SubscriptionStateOverrideAction
}

func (ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications) MarshalJSON added in v0.2.0

MarshalJSON implements the json.Marshaller interface for type ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications.

func (*ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications.

type ProviderRegistrationsClient

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

ProviderRegistrationsClient contains the methods for the ProviderRegistrations group. Don't use this type directly, use NewProviderRegistrationsClient() instead.

func NewProviderRegistrationsClient

func NewProviderRegistrationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ProviderRegistrationsClient, error)

NewProviderRegistrationsClient creates a new instance of ProviderRegistrationsClient with the specified values.

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

func (*ProviderRegistrationsClient) BeginCreateOrUpdate

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

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • properties - The provider registration properties supplied to the CreateOrUpdate operation.
  • options - ProviderRegistrationsClientBeginCreateOrUpdateOptions contains the optional parameters for the ProviderRegistrationsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/ProviderRegistrations_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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewProviderRegistrationsClient().BeginCreateOrUpdate(ctx, "Microsoft.Contoso", armproviderhub.ProviderRegistration{
		Properties: &armproviderhub.ProviderRegistrationProperties{
			Capabilities: []*armproviderhub.ResourceProviderCapabilities{
				{
					Effect:  to.Ptr(armproviderhub.ResourceProviderCapabilitiesEffectAllow),
					QuotaID: to.Ptr("CSP_2015-05-01"),
				},
				{
					Effect:  to.Ptr(armproviderhub.ResourceProviderCapabilitiesEffectAllow),
					QuotaID: to.Ptr("CSP_MG_2017-12-01"),
				}},
			Management: &armproviderhub.ResourceProviderManifestPropertiesManagement{
				IncidentContactEmail:   to.Ptr("helpme@contoso.com"),
				IncidentRoutingService: to.Ptr("Contoso Resource Provider"),
				IncidentRoutingTeam:    to.Ptr("Contoso Triage"),
			},
			ProviderType:    to.Ptr(armproviderhub.ResourceProviderTypeInternal),
			ProviderVersion: to.Ptr("2.0"),
		},
	}, 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.ProviderRegistration = armproviderhub.ProviderRegistration{
	// 	Properties: &armproviderhub.ProviderRegistrationProperties{
	// 		Capabilities: []*armproviderhub.ResourceProviderCapabilities{
	// 			{
	// 				Effect: to.Ptr(armproviderhub.ResourceProviderCapabilitiesEffectAllow),
	// 				QuotaID: to.Ptr("CSP_2015-05-01"),
	// 			},
	// 			{
	// 				Effect: to.Ptr(armproviderhub.ResourceProviderCapabilitiesEffectAllow),
	// 				QuotaID: to.Ptr("CSP_MG_2017-12-01"),
	// 		}},
	// 		Management: &armproviderhub.ResourceProviderManifestPropertiesManagement{
	// 			IncidentContactEmail: to.Ptr("helpme@contoso.com"),
	// 			IncidentRoutingService: to.Ptr(""),
	// 			IncidentRoutingTeam: to.Ptr(""),
	// 			ManifestOwners: []*string{
	// 				to.Ptr("manifestOwners-group")},
	// 				ResourceAccessPolicy: to.Ptr(armproviderhub.ResourceProviderManagementResourceAccessPolicyNotSpecified),
	// 			},
	// 			Metadata: map[string]any{
	// 				"onboardedVia": "ProviderHub",
	// 			},
	// 			Namespace: to.Ptr("Microsoft.Contoso"),
	// 			ProviderAuthorizations: []*armproviderhub.ResourceProviderAuthorization{
	// 				{
	// 					ApplicationID: to.Ptr("1a3b5c7d-8e9f-10g1-1h12-i13j14k1"),
	// 					RoleDefinitionID: to.Ptr("123456bf-gkur-2098-b890-98da392a00b2"),
	// 			}},
	// 			ProviderType: to.Ptr(armproviderhub.ResourceProviderType("Internal, Hidden")),
	// 			ProviderVersion: to.Ptr("2.0"),
	// 			ProvisioningState: to.Ptr(armproviderhub.ProvisioningStateSucceeded),
	// 		},
	// 	}
}
Output:

func (*ProviderRegistrationsClient) Delete

Delete - Deletes a provider registration. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • options - ProviderRegistrationsClientDeleteOptions contains the optional parameters for the ProviderRegistrationsClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/ProviderRegistrations_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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewProviderRegistrationsClient().Delete(ctx, "Microsoft.Contoso", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*ProviderRegistrationsClient) GenerateOperations

GenerateOperations - Generates the operations api for the given provider. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • options - ProviderRegistrationsClientGenerateOperationsOptions contains the optional parameters for the ProviderRegistrationsClient.GenerateOperations method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/ProviderRegistrations_GenerateOperations.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewProviderRegistrationsClient().GenerateOperations(ctx, "Microsoft.Contoso", 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.OperationsDefinitionArray = []*armproviderhub.OperationsDefinition{
	// 	{
	// 		Name: to.Ptr("Microsoft.Contoso/Employees/Read"),
	// 		Display: &armproviderhub.OperationsDefinitionDisplay{
	// 			Description: to.Ptr("Read employees"),
	// 			Operation: to.Ptr("Gets/List employee resources"),
	// 			Provider: to.Ptr("Microsoft.Contoso"),
	// 			Resource: to.Ptr("Employees"),
	// 		},
	// 		IsDataAction: to.Ptr(false),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Contoso/Employees/Write"),
	// 		Display: &armproviderhub.OperationsDefinitionDisplay{
	// 			Description: to.Ptr("Writes employees"),
	// 			Operation: to.Ptr("Create/update employee resources"),
	// 			Provider: to.Ptr("Microsoft.Contoso"),
	// 			Resource: to.Ptr("Employees"),
	// 		},
	// 		IsDataAction: to.Ptr(false),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Contoso/Employees/Delete"),
	// 		Display: &armproviderhub.OperationsDefinitionDisplay{
	// 			Description: to.Ptr("Deletes employees"),
	// 			Operation: to.Ptr("Deletes employee resource"),
	// 			Provider: to.Ptr("Microsoft.Contoso"),
	// 			Resource: to.Ptr("Employees"),
	// 		},
	// 		IsDataAction: to.Ptr(false),
	// 		Origin: to.Ptr(armproviderhub.OperationsDefinitionOriginUser),
	// 	},
	// 	{
	// 		Name: to.Ptr("Microsoft.Contoso/Employees/Action"),
	// 		Display: &armproviderhub.OperationsDefinitionDisplay{
	// 			Description: to.Ptr("Writes employees"),
	// 			Operation: to.Ptr("Create/update employee resources"),
	// 			Provider: to.Ptr("Microsoft.Contoso"),
	// 			Resource: to.Ptr("Employees"),
	// 		},
	// 		IsDataAction: to.Ptr(true),
	// 		Origin: to.Ptr(armproviderhub.OperationsDefinitionOriginSystem),
	// }}
}
Output:

func (*ProviderRegistrationsClient) Get

Get - Gets the provider registration details. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • options - ProviderRegistrationsClientGetOptions contains the optional parameters for the ProviderRegistrationsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/ProviderRegistrations_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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewProviderRegistrationsClient().Get(ctx, "Microsoft.Contoso", 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.ProviderRegistration = armproviderhub.ProviderRegistration{
	// 	Properties: &armproviderhub.ProviderRegistrationProperties{
	// 		Capabilities: []*armproviderhub.ResourceProviderCapabilities{
	// 			{
	// 				Effect: to.Ptr(armproviderhub.ResourceProviderCapabilitiesEffectAllow),
	// 				QuotaID: to.Ptr("CSP_2015-05-01"),
	// 			},
	// 			{
	// 				Effect: to.Ptr(armproviderhub.ResourceProviderCapabilitiesEffectAllow),
	// 				QuotaID: to.Ptr("CSP_MG_2017-12-01"),
	// 		}},
	// 		Management: &armproviderhub.ResourceProviderManifestPropertiesManagement{
	// 			IncidentContactEmail: to.Ptr("helpme@contoso.com"),
	// 			IncidentRoutingService: to.Ptr(""),
	// 			IncidentRoutingTeam: to.Ptr(""),
	// 			ManifestOwners: []*string{
	// 				to.Ptr("SPARTA-PlatformServiceAdministrator")},
	// 				ResourceAccessPolicy: to.Ptr(armproviderhub.ResourceProviderManagementResourceAccessPolicyNotSpecified),
	// 			},
	// 			Namespace: to.Ptr("microsoft.contoso"),
	// 			ProviderAuthorizations: []*armproviderhub.ResourceProviderAuthorization{
	// 				{
	// 					ApplicationID: to.Ptr("1a3b5c7d-8e9f-10g1-1h12-i13j14k1"),
	// 					RoleDefinitionID: to.Ptr("123456bf-gkur-2098-b890-98da392a00b2"),
	// 			}},
	// 			ProviderType: to.Ptr(armproviderhub.ResourceProviderType("Internal, Hidden")),
	// 			ProviderVersion: to.Ptr("2.0"),
	// 			ProviderHubMetadata: &armproviderhub.ProviderRegistrationPropertiesProviderHubMetadata{
	// 				ProviderAuthentication: &armproviderhub.MetadataProviderAuthentication{
	// 					AllowedAudiences: []*string{
	// 						to.Ptr("https://management.core.windows.net/")},
	// 					},
	// 				},
	// 				ProvisioningState: to.Ptr(armproviderhub.ProvisioningStateSucceeded),
	// 			},
	// 		}
}
Output:

func (*ProviderRegistrationsClient) NewListPager added in v0.4.0

NewListPager - Gets the list of the provider registrations in the subscription.

Generated from API version 2020-11-20

  • options - ProviderRegistrationsClientListOptions contains the optional parameters for the ProviderRegistrationsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/ProviderRegistrations_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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewProviderRegistrationsClient().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.ProviderRegistrationArrayResponseWithContinuation = armproviderhub.ProviderRegistrationArrayResponseWithContinuation{
		// 	Value: []*armproviderhub.ProviderRegistration{
		// 		{
		// 			Properties: &armproviderhub.ProviderRegistrationProperties{
		// 				Capabilities: []*armproviderhub.ResourceProviderCapabilities{
		// 					{
		// 						Effect: to.Ptr(armproviderhub.ResourceProviderCapabilitiesEffectAllow),
		// 						QuotaID: to.Ptr("CSP_2015-05-01"),
		// 					},
		// 					{
		// 						Effect: to.Ptr(armproviderhub.ResourceProviderCapabilitiesEffectAllow),
		// 						QuotaID: to.Ptr("CSP_MG_2017-12-01"),
		// 				}},
		// 				Management: &armproviderhub.ResourceProviderManifestPropertiesManagement{
		// 					IncidentContactEmail: to.Ptr("helpme@contoso.com"),
		// 					IncidentRoutingService: to.Ptr(""),
		// 					IncidentRoutingTeam: to.Ptr(""),
		// 					ManifestOwners: []*string{
		// 						to.Ptr("manifestOwners-group")},
		// 						ResourceAccessPolicy: to.Ptr(armproviderhub.ResourceProviderManagementResourceAccessPolicyNotSpecified),
		// 					},
		// 					Namespace: to.Ptr("microsoft.contoso"),
		// 					ProviderAuthorizations: []*armproviderhub.ResourceProviderAuthorization{
		// 						{
		// 							ApplicationID: to.Ptr("1a3b5c7d-8e9f-10g1-1h12-i13j14k1"),
		// 							RoleDefinitionID: to.Ptr("123456bf-gkur-2098-b890-98da392a00b2"),
		// 					}},
		// 					ProviderType: to.Ptr(armproviderhub.ResourceProviderType("Internal, Hidden")),
		// 					ProviderVersion: to.Ptr("2.0"),
		// 					ProviderHubMetadata: &armproviderhub.ProviderRegistrationPropertiesProviderHubMetadata{
		// 						ProviderAuthentication: &armproviderhub.MetadataProviderAuthentication{
		// 							AllowedAudiences: []*string{
		// 								to.Ptr("https://management.core.windows.net/")},
		// 							},
		// 						},
		// 						ProvisioningState: to.Ptr(armproviderhub.ProvisioningStateSucceeded),
		// 					},
		// 			}},
		// 		}
	}
}
Output:

type ProviderRegistrationsClientBeginCreateOrUpdateOptions added in v0.2.0

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

ProviderRegistrationsClientBeginCreateOrUpdateOptions contains the optional parameters for the ProviderRegistrationsClient.BeginCreateOrUpdate method.

type ProviderRegistrationsClientCreateOrUpdateResponse added in v0.2.0

type ProviderRegistrationsClientCreateOrUpdateResponse struct {
	ProviderRegistration
}

ProviderRegistrationsClientCreateOrUpdateResponse contains the response from method ProviderRegistrationsClient.BeginCreateOrUpdate.

type ProviderRegistrationsClientDeleteOptions added in v0.2.0

type ProviderRegistrationsClientDeleteOptions struct {
}

ProviderRegistrationsClientDeleteOptions contains the optional parameters for the ProviderRegistrationsClient.Delete method.

type ProviderRegistrationsClientDeleteResponse added in v0.2.0

type ProviderRegistrationsClientDeleteResponse struct {
}

ProviderRegistrationsClientDeleteResponse contains the response from method ProviderRegistrationsClient.Delete.

type ProviderRegistrationsClientGenerateOperationsOptions added in v0.2.0

type ProviderRegistrationsClientGenerateOperationsOptions struct {
}

ProviderRegistrationsClientGenerateOperationsOptions contains the optional parameters for the ProviderRegistrationsClient.GenerateOperations method.

type ProviderRegistrationsClientGenerateOperationsResponse added in v0.2.0

type ProviderRegistrationsClientGenerateOperationsResponse struct {
	// Array of OperationsDefinition
	OperationsDefinitionArray []*OperationsDefinition
}

ProviderRegistrationsClientGenerateOperationsResponse contains the response from method ProviderRegistrationsClient.GenerateOperations.

type ProviderRegistrationsClientGetOptions added in v0.2.0

type ProviderRegistrationsClientGetOptions struct {
}

ProviderRegistrationsClientGetOptions contains the optional parameters for the ProviderRegistrationsClient.Get method.

type ProviderRegistrationsClientGetResponse added in v0.2.0

type ProviderRegistrationsClientGetResponse struct {
	ProviderRegistration
}

ProviderRegistrationsClientGetResponse contains the response from method ProviderRegistrationsClient.Get.

type ProviderRegistrationsClientListOptions added in v0.2.0

type ProviderRegistrationsClientListOptions struct {
}

ProviderRegistrationsClientListOptions contains the optional parameters for the ProviderRegistrationsClient.NewListPager method.

type ProviderRegistrationsClientListResponse added in v0.2.0

type ProviderRegistrationsClientListResponse struct {
	ProviderRegistrationArrayResponseWithContinuation
}

ProviderRegistrationsClientListResponse contains the response from method ProviderRegistrationsClient.NewListPager.

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateAccepted          ProvisioningState = "Accepted"
	ProvisioningStateCanceled          ProvisioningState = "Canceled"
	ProvisioningStateCreated           ProvisioningState = "Created"
	ProvisioningStateCreating          ProvisioningState = "Creating"
	ProvisioningStateDeleted           ProvisioningState = "Deleted"
	ProvisioningStateDeleting          ProvisioningState = "Deleting"
	ProvisioningStateFailed            ProvisioningState = "Failed"
	ProvisioningStateMovingResources   ProvisioningState = "MovingResources"
	ProvisioningStateNotSpecified      ProvisioningState = "NotSpecified"
	ProvisioningStateRolloutInProgress ProvisioningState = "RolloutInProgress"
	ProvisioningStateRunning           ProvisioningState = "Running"
	ProvisioningStateSucceeded         ProvisioningState = "Succeeded"
	ProvisioningStateTransientFailure  ProvisioningState = "TransientFailure"
)

func PossibleProvisioningStateValues

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type ProxyResource

type ProxyResource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

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

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 ReRegisterSubscriptionMetadata

type ReRegisterSubscriptionMetadata struct {
	// REQUIRED
	Enabled          *bool
	ConcurrencyLimit *int32
}

func (ReRegisterSubscriptionMetadata) MarshalJSON added in v1.1.0

func (r ReRegisterSubscriptionMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReRegisterSubscriptionMetadata.

func (*ReRegisterSubscriptionMetadata) UnmarshalJSON added in v1.1.0

func (r *ReRegisterSubscriptionMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReRegisterSubscriptionMetadata.

type Regionality

type Regionality string
const (
	RegionalityGlobal       Regionality = "Global"
	RegionalityNotSpecified Regionality = "NotSpecified"
	RegionalityRegional     Regionality = "Regional"
)

func PossibleRegionalityValues

func PossibleRegionalityValues() []Regionality

PossibleRegionalityValues returns the possible values for the Regionality const type.

type RequestHeaderOptions

type RequestHeaderOptions struct {
	OptInHeaders *OptInHeaderType
}

func (RequestHeaderOptions) MarshalJSON added in v1.1.0

func (r RequestHeaderOptions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RequestHeaderOptions.

func (*RequestHeaderOptions) UnmarshalJSON added in v1.1.0

func (r *RequestHeaderOptions) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RequestHeaderOptions.

type Resource

type Resource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

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

func (Resource) MarshalJSON added in v1.1.0

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Resource.

func (*Resource) UnmarshalJSON added in v1.1.0

func (r *Resource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Resource.

type ResourceDeletionPolicy

type ResourceDeletionPolicy string
const (
	ResourceDeletionPolicyCascadeDeleteAll               ResourceDeletionPolicy = "CascadeDeleteAll"
	ResourceDeletionPolicyCascadeDeleteProxyOnlyChildren ResourceDeletionPolicy = "CascadeDeleteProxyOnlyChildren"
	ResourceDeletionPolicyNotSpecified                   ResourceDeletionPolicy = "NotSpecified"
)

func PossibleResourceDeletionPolicyValues

func PossibleResourceDeletionPolicyValues() []ResourceDeletionPolicy

PossibleResourceDeletionPolicyValues returns the possible values for the ResourceDeletionPolicy const type.

type ResourceMovePolicy

type ResourceMovePolicy struct {
	CrossResourceGroupMoveEnabled *bool
	CrossSubscriptionMoveEnabled  *bool
	ValidationRequired            *bool
}

func (ResourceMovePolicy) MarshalJSON added in v1.1.0

func (r ResourceMovePolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceMovePolicy.

func (*ResourceMovePolicy) UnmarshalJSON added in v1.1.0

func (r *ResourceMovePolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceMovePolicy.

type ResourceProviderAuthentication

type ResourceProviderAuthentication struct {
	// REQUIRED
	AllowedAudiences []*string
}

func (ResourceProviderAuthentication) MarshalJSON

func (r ResourceProviderAuthentication) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceProviderAuthentication.

func (*ResourceProviderAuthentication) UnmarshalJSON added in v1.1.0

func (r *ResourceProviderAuthentication) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderAuthentication.

type ResourceProviderAuthorization

type ResourceProviderAuthorization struct {
	ApplicationID             *string
	ManagedByRoleDefinitionID *string
	RoleDefinitionID          *string
}

func (ResourceProviderAuthorization) MarshalJSON added in v1.1.0

func (r ResourceProviderAuthorization) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceProviderAuthorization.

func (*ResourceProviderAuthorization) UnmarshalJSON added in v1.1.0

func (r *ResourceProviderAuthorization) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderAuthorization.

type ResourceProviderCapabilities

type ResourceProviderCapabilities struct {
	// REQUIRED
	Effect *ResourceProviderCapabilitiesEffect

	// REQUIRED
	QuotaID          *string
	RequiredFeatures []*string
}

func (ResourceProviderCapabilities) MarshalJSON

func (r ResourceProviderCapabilities) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceProviderCapabilities.

func (*ResourceProviderCapabilities) UnmarshalJSON added in v1.1.0

func (r *ResourceProviderCapabilities) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderCapabilities.

type ResourceProviderCapabilitiesEffect

type ResourceProviderCapabilitiesEffect string
const (
	ResourceProviderCapabilitiesEffectAllow        ResourceProviderCapabilitiesEffect = "Allow"
	ResourceProviderCapabilitiesEffectDisallow     ResourceProviderCapabilitiesEffect = "Disallow"
	ResourceProviderCapabilitiesEffectNotSpecified ResourceProviderCapabilitiesEffect = "NotSpecified"
)

func PossibleResourceProviderCapabilitiesEffectValues

func PossibleResourceProviderCapabilitiesEffectValues() []ResourceProviderCapabilitiesEffect

PossibleResourceProviderCapabilitiesEffectValues returns the possible values for the ResourceProviderCapabilitiesEffect const type.

type ResourceProviderEndpoint

type ResourceProviderEndpoint struct {
	APIVersions      []*string
	Enabled          *bool
	EndpointURI      *string
	FeaturesRule     *ResourceProviderEndpointFeaturesRule
	Locations        []*string
	RequiredFeatures []*string
	Timeout          *string
}

func (ResourceProviderEndpoint) MarshalJSON

func (r ResourceProviderEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceProviderEndpoint.

func (*ResourceProviderEndpoint) UnmarshalJSON added in v1.1.0

func (r *ResourceProviderEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderEndpoint.

type ResourceProviderEndpointFeaturesRule

type ResourceProviderEndpointFeaturesRule struct {
	// REQUIRED
	RequiredFeaturesPolicy *FeaturesPolicy
}

func (ResourceProviderEndpointFeaturesRule) MarshalJSON added in v1.1.0

func (r ResourceProviderEndpointFeaturesRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceProviderEndpointFeaturesRule.

func (*ResourceProviderEndpointFeaturesRule) UnmarshalJSON added in v1.1.0

func (r *ResourceProviderEndpointFeaturesRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderEndpointFeaturesRule.

type ResourceProviderManagement

type ResourceProviderManagement struct {
	IncidentContactEmail   *string
	IncidentRoutingService *string
	IncidentRoutingTeam    *string
	ManifestOwners         []*string
	ResourceAccessPolicy   *ResourceProviderManagementResourceAccessPolicy
	ResourceAccessRoles    []any
	SchemaOwners           []*string
	ServiceTreeInfos       []*ServiceTreeInfo
}

func (ResourceProviderManagement) MarshalJSON

func (r ResourceProviderManagement) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceProviderManagement.

func (*ResourceProviderManagement) UnmarshalJSON added in v1.1.0

func (r *ResourceProviderManagement) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderManagement.

type ResourceProviderManagementResourceAccessPolicy

type ResourceProviderManagementResourceAccessPolicy string
const (
	ResourceProviderManagementResourceAccessPolicyAcisActionAllowed ResourceProviderManagementResourceAccessPolicy = "AcisActionAllowed"
	ResourceProviderManagementResourceAccessPolicyAcisReadAllowed   ResourceProviderManagementResourceAccessPolicy = "AcisReadAllowed"
	ResourceProviderManagementResourceAccessPolicyNotSpecified      ResourceProviderManagementResourceAccessPolicy = "NotSpecified"
)

func PossibleResourceProviderManagementResourceAccessPolicyValues

func PossibleResourceProviderManagementResourceAccessPolicyValues() []ResourceProviderManagementResourceAccessPolicy

PossibleResourceProviderManagementResourceAccessPolicyValues returns the possible values for the ResourceProviderManagementResourceAccessPolicy const type.

type ResourceProviderManifest

type ResourceProviderManifest struct {
	Capabilities                []*ResourceProviderCapabilities
	FeaturesRule                *ResourceProviderManifestFeaturesRule
	GlobalNotificationEndpoints []*ResourceProviderEndpoint
	Management                  *ResourceProviderManifestManagement

	// Anything
	Metadata                       any
	Namespace                      *string
	ProviderAuthentication         *ResourceProviderManifestProviderAuthentication
	ProviderAuthorizations         []*ResourceProviderAuthorization
	ProviderType                   *ResourceProviderType
	ProviderVersion                *string
	ReRegisterSubscriptionMetadata *ResourceProviderManifestReRegisterSubscriptionMetadata
	RequestHeaderOptions           *ResourceProviderManifestRequestHeaderOptions
	RequiredFeatures               []*string
	ResourceTypes                  []*ResourceType
}

func (ResourceProviderManifest) MarshalJSON

func (r ResourceProviderManifest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceProviderManifest.

func (*ResourceProviderManifest) UnmarshalJSON added in v1.1.0

func (r *ResourceProviderManifest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderManifest.

type ResourceProviderManifestFeaturesRule

type ResourceProviderManifestFeaturesRule struct {
	// REQUIRED
	RequiredFeaturesPolicy *FeaturesPolicy
}

func (ResourceProviderManifestFeaturesRule) MarshalJSON added in v1.1.0

func (r ResourceProviderManifestFeaturesRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceProviderManifestFeaturesRule.

func (*ResourceProviderManifestFeaturesRule) UnmarshalJSON added in v1.1.0

func (r *ResourceProviderManifestFeaturesRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderManifestFeaturesRule.

type ResourceProviderManifestManagement

type ResourceProviderManifestManagement struct {
	IncidentContactEmail   *string
	IncidentRoutingService *string
	IncidentRoutingTeam    *string
	ManifestOwners         []*string
	ResourceAccessPolicy   *ResourceProviderManagementResourceAccessPolicy
	ResourceAccessRoles    []any
	SchemaOwners           []*string
	ServiceTreeInfos       []*ServiceTreeInfo
}

func (ResourceProviderManifestManagement) MarshalJSON added in v0.2.0

func (r ResourceProviderManifestManagement) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceProviderManifestManagement.

func (*ResourceProviderManifestManagement) UnmarshalJSON added in v1.1.0

func (r *ResourceProviderManifestManagement) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderManifestManagement.

type ResourceProviderManifestProperties

type ResourceProviderManifestProperties struct {
	Capabilities []*ResourceProviderCapabilities
	FeaturesRule *ResourceProviderManifestPropertiesFeaturesRule
	Management   *ResourceProviderManifestPropertiesManagement

	// Anything
	Metadata                  any
	Namespace                 *string
	ProviderAuthentication    *ResourceProviderManifestPropertiesProviderAuthentication
	ProviderAuthorizations    []*ResourceProviderAuthorization
	ProviderType              *ResourceProviderType
	ProviderVersion           *string
	RequestHeaderOptions      *ResourceProviderManifestPropertiesRequestHeaderOptions
	RequiredFeatures          []*string
	TemplateDeploymentOptions *ResourceProviderManifestPropertiesTemplateDeploymentOptions
}

func (ResourceProviderManifestProperties) MarshalJSON

func (r ResourceProviderManifestProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceProviderManifestProperties.

func (*ResourceProviderManifestProperties) UnmarshalJSON added in v1.1.0

func (r *ResourceProviderManifestProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderManifestProperties.

type ResourceProviderManifestPropertiesFeaturesRule

type ResourceProviderManifestPropertiesFeaturesRule struct {
	// REQUIRED
	RequiredFeaturesPolicy *FeaturesPolicy
}

func (ResourceProviderManifestPropertiesFeaturesRule) MarshalJSON added in v1.1.0

MarshalJSON implements the json.Marshaller interface for type ResourceProviderManifestPropertiesFeaturesRule.

func (*ResourceProviderManifestPropertiesFeaturesRule) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderManifestPropertiesFeaturesRule.

type ResourceProviderManifestPropertiesManagement

type ResourceProviderManifestPropertiesManagement struct {
	IncidentContactEmail   *string
	IncidentRoutingService *string
	IncidentRoutingTeam    *string
	ManifestOwners         []*string
	ResourceAccessPolicy   *ResourceProviderManagementResourceAccessPolicy
	ResourceAccessRoles    []any
	SchemaOwners           []*string
	ServiceTreeInfos       []*ServiceTreeInfo
}

func (ResourceProviderManifestPropertiesManagement) MarshalJSON added in v0.2.0

MarshalJSON implements the json.Marshaller interface for type ResourceProviderManifestPropertiesManagement.

func (*ResourceProviderManifestPropertiesManagement) UnmarshalJSON added in v1.1.0

func (r *ResourceProviderManifestPropertiesManagement) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderManifestPropertiesManagement.

type ResourceProviderManifestPropertiesProviderAuthentication

type ResourceProviderManifestPropertiesProviderAuthentication struct {
	// REQUIRED
	AllowedAudiences []*string
}

func (ResourceProviderManifestPropertiesProviderAuthentication) MarshalJSON added in v0.2.0

MarshalJSON implements the json.Marshaller interface for type ResourceProviderManifestPropertiesProviderAuthentication.

func (*ResourceProviderManifestPropertiesProviderAuthentication) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderManifestPropertiesProviderAuthentication.

type ResourceProviderManifestPropertiesRequestHeaderOptions

type ResourceProviderManifestPropertiesRequestHeaderOptions struct {
	OptInHeaders *OptInHeaderType
}

func (ResourceProviderManifestPropertiesRequestHeaderOptions) MarshalJSON added in v1.1.0

MarshalJSON implements the json.Marshaller interface for type ResourceProviderManifestPropertiesRequestHeaderOptions.

func (*ResourceProviderManifestPropertiesRequestHeaderOptions) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderManifestPropertiesRequestHeaderOptions.

type ResourceProviderManifestPropertiesTemplateDeploymentOptions

type ResourceProviderManifestPropertiesTemplateDeploymentOptions struct {
	PreflightOptions   []*PreflightOption
	PreflightSupported *bool
}

func (ResourceProviderManifestPropertiesTemplateDeploymentOptions) MarshalJSON added in v0.2.0

MarshalJSON implements the json.Marshaller interface for type ResourceProviderManifestPropertiesTemplateDeploymentOptions.

func (*ResourceProviderManifestPropertiesTemplateDeploymentOptions) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderManifestPropertiesTemplateDeploymentOptions.

type ResourceProviderManifestProviderAuthentication

type ResourceProviderManifestProviderAuthentication struct {
	// REQUIRED
	AllowedAudiences []*string
}

func (ResourceProviderManifestProviderAuthentication) MarshalJSON added in v0.2.0

MarshalJSON implements the json.Marshaller interface for type ResourceProviderManifestProviderAuthentication.

func (*ResourceProviderManifestProviderAuthentication) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderManifestProviderAuthentication.

type ResourceProviderManifestReRegisterSubscriptionMetadata

type ResourceProviderManifestReRegisterSubscriptionMetadata struct {
	// REQUIRED
	Enabled          *bool
	ConcurrencyLimit *int32
}

func (ResourceProviderManifestReRegisterSubscriptionMetadata) MarshalJSON added in v1.1.0

MarshalJSON implements the json.Marshaller interface for type ResourceProviderManifestReRegisterSubscriptionMetadata.

func (*ResourceProviderManifestReRegisterSubscriptionMetadata) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderManifestReRegisterSubscriptionMetadata.

type ResourceProviderManifestRequestHeaderOptions

type ResourceProviderManifestRequestHeaderOptions struct {
	OptInHeaders *OptInHeaderType
}

func (ResourceProviderManifestRequestHeaderOptions) MarshalJSON added in v1.1.0

MarshalJSON implements the json.Marshaller interface for type ResourceProviderManifestRequestHeaderOptions.

func (*ResourceProviderManifestRequestHeaderOptions) UnmarshalJSON added in v1.1.0

func (r *ResourceProviderManifestRequestHeaderOptions) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderManifestRequestHeaderOptions.

type ResourceProviderType

type ResourceProviderType string
const (
	ResourceProviderTypeAuthorizationFree          ResourceProviderType = "AuthorizationFree"
	ResourceProviderTypeExternal                   ResourceProviderType = "External"
	ResourceProviderTypeHidden                     ResourceProviderType = "Hidden"
	ResourceProviderTypeInternal                   ResourceProviderType = "Internal"
	ResourceProviderTypeLegacyRegistrationRequired ResourceProviderType = "LegacyRegistrationRequired"
	ResourceProviderTypeNotSpecified               ResourceProviderType = "NotSpecified"
	ResourceProviderTypeRegistrationFree           ResourceProviderType = "RegistrationFree"
	ResourceProviderTypeTenantOnly                 ResourceProviderType = "TenantOnly"
)

func PossibleResourceProviderTypeValues

func PossibleResourceProviderTypeValues() []ResourceProviderType

PossibleResourceProviderTypeValues returns the possible values for the ResourceProviderType const type.

type ResourceType

type ResourceType struct {
	AllowedUnauthorizedActions  []*string
	AuthorizationActionMappings []*AuthorizationActionMapping
	DefaultAPIVersion           *string
	DisallowedActionVerbs       []*string
	Endpoints                   []*ResourceProviderEndpoint
	ExtendedLocations           []*ExtendedLocationOptions
	FeaturesRule                *ResourceTypeFeaturesRule
	IdentityManagement          *ResourceTypeIdentityManagement
	LinkedAccessChecks          []*LinkedAccessCheck
	LinkedOperationRules        []*LinkedOperationRule
	LoggingRules                []*LoggingRule
	MarketplaceType             *ResourceTypeMarketplaceType

	// Anything
	Metadata                 any
	Name                     *string
	RequestHeaderOptions     *ResourceTypeRequestHeaderOptions
	RequiredFeatures         []*string
	ResourceDeletionPolicy   *ManifestResourceDeletionPolicy
	ResourceValidation       *ResourceValidation
	RoutingType              *RoutingType
	SKULink                  *string
	ServiceTreeInfos         []*ServiceTreeInfo
	SubscriptionStateRules   []*SubscriptionStateRule
	TemplateDeploymentPolicy *ResourceTypeTemplateDeploymentPolicy
	ThrottlingRules          []*ThrottlingRule
}

func (ResourceType) MarshalJSON

func (r ResourceType) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceType.

func (*ResourceType) UnmarshalJSON added in v1.1.0

func (r *ResourceType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceType.

type ResourceTypeEndpoint

type ResourceTypeEndpoint struct {
	APIVersions      []*string
	Enabled          *bool
	Extensions       []*ResourceTypeExtension
	FeaturesRule     *ResourceTypeEndpointFeaturesRule
	Locations        []*string
	RequiredFeatures []*string
	Timeout          *string
}

func (ResourceTypeEndpoint) MarshalJSON

func (r ResourceTypeEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceTypeEndpoint.

func (*ResourceTypeEndpoint) UnmarshalJSON added in v1.1.0

func (r *ResourceTypeEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeEndpoint.

type ResourceTypeEndpointFeaturesRule

type ResourceTypeEndpointFeaturesRule struct {
	// REQUIRED
	RequiredFeaturesPolicy *FeaturesPolicy
}

func (ResourceTypeEndpointFeaturesRule) MarshalJSON added in v1.1.0

func (r ResourceTypeEndpointFeaturesRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceTypeEndpointFeaturesRule.

func (*ResourceTypeEndpointFeaturesRule) UnmarshalJSON added in v1.1.0

func (r *ResourceTypeEndpointFeaturesRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeEndpointFeaturesRule.

type ResourceTypeExtension

type ResourceTypeExtension struct {
	EndpointURI         *string
	ExtensionCategories []*ExtensionCategory
	Timeout             *string
}

func (ResourceTypeExtension) MarshalJSON

func (r ResourceTypeExtension) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceTypeExtension.

func (*ResourceTypeExtension) UnmarshalJSON added in v1.1.0

func (r *ResourceTypeExtension) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeExtension.

type ResourceTypeExtensionOptions

type ResourceTypeExtensionOptions struct {
	ResourceCreationBegin *ResourceTypeExtensionOptionsResourceCreationBegin
}

func (ResourceTypeExtensionOptions) MarshalJSON added in v1.1.0

func (r ResourceTypeExtensionOptions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceTypeExtensionOptions.

func (*ResourceTypeExtensionOptions) UnmarshalJSON added in v1.1.0

func (r *ResourceTypeExtensionOptions) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeExtensionOptions.

type ResourceTypeExtensionOptionsResourceCreationBegin

type ResourceTypeExtensionOptionsResourceCreationBegin struct {
	Request  []*ExtensionOptionType
	Response []*ExtensionOptionType
}

func (ResourceTypeExtensionOptionsResourceCreationBegin) MarshalJSON added in v0.2.0

MarshalJSON implements the json.Marshaller interface for type ResourceTypeExtensionOptionsResourceCreationBegin.

func (*ResourceTypeExtensionOptionsResourceCreationBegin) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeExtensionOptionsResourceCreationBegin.

type ResourceTypeFeaturesRule

type ResourceTypeFeaturesRule struct {
	// REQUIRED
	RequiredFeaturesPolicy *FeaturesPolicy
}

func (ResourceTypeFeaturesRule) MarshalJSON added in v1.1.0

func (r ResourceTypeFeaturesRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceTypeFeaturesRule.

func (*ResourceTypeFeaturesRule) UnmarshalJSON added in v1.1.0

func (r *ResourceTypeFeaturesRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeFeaturesRule.

type ResourceTypeIdentityManagement

type ResourceTypeIdentityManagement struct {
	Type *IdentityManagementTypes
}

func (ResourceTypeIdentityManagement) MarshalJSON added in v1.1.0

func (r ResourceTypeIdentityManagement) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceTypeIdentityManagement.

func (*ResourceTypeIdentityManagement) UnmarshalJSON added in v1.1.0

func (r *ResourceTypeIdentityManagement) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeIdentityManagement.

type ResourceTypeMarketplaceType

type ResourceTypeMarketplaceType string
const (
	ResourceTypeMarketplaceTypeAddOn        ResourceTypeMarketplaceType = "AddOn"
	ResourceTypeMarketplaceTypeBypass       ResourceTypeMarketplaceType = "Bypass"
	ResourceTypeMarketplaceTypeNotSpecified ResourceTypeMarketplaceType = "NotSpecified"
	ResourceTypeMarketplaceTypeStore        ResourceTypeMarketplaceType = "Store"
)

func PossibleResourceTypeMarketplaceTypeValues

func PossibleResourceTypeMarketplaceTypeValues() []ResourceTypeMarketplaceType

PossibleResourceTypeMarketplaceTypeValues returns the possible values for the ResourceTypeMarketplaceType const type.

type ResourceTypeRegistration

type ResourceTypeRegistration struct {
	Properties *ResourceTypeRegistrationProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

func (ResourceTypeRegistration) MarshalJSON added in v1.1.0

func (r ResourceTypeRegistration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceTypeRegistration.

func (*ResourceTypeRegistration) UnmarshalJSON added in v1.1.0

func (r *ResourceTypeRegistration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeRegistration.

type ResourceTypeRegistrationArrayResponseWithContinuation

type ResourceTypeRegistrationArrayResponseWithContinuation struct {
	// The URL to get to the next set of results, if there are any.
	NextLink *string
	Value    []*ResourceTypeRegistration
}

func (ResourceTypeRegistrationArrayResponseWithContinuation) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ResourceTypeRegistrationArrayResponseWithContinuation.

func (*ResourceTypeRegistrationArrayResponseWithContinuation) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeRegistrationArrayResponseWithContinuation.

type ResourceTypeRegistrationProperties

type ResourceTypeRegistrationProperties struct {
	AllowedUnauthorizedActions                      []*string
	AuthorizationActionMappings                     []*AuthorizationActionMapping
	CheckNameAvailabilitySpecifications             *ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecifications
	DefaultAPIVersion                               *string
	DisallowedActionVerbs                           []*string
	EnableAsyncOperation                            *bool
	EnableThirdPartyS2S                             *bool
	Endpoints                                       []*ResourceTypeEndpoint
	ExtendedLocations                               []*ExtendedLocationOptions
	ExtensionOptions                                *ResourceTypeRegistrationPropertiesExtensionOptions
	FeaturesRule                                    *ResourceTypeRegistrationPropertiesFeaturesRule
	IdentityManagement                              *ResourceTypeRegistrationPropertiesIdentityManagement
	IsPureProxy                                     *bool
	LinkedAccessChecks                              []*LinkedAccessCheck
	LoggingRules                                    []*LoggingRule
	MarketplaceType                                 *ResourceTypeRegistrationPropertiesMarketplaceType
	ProvisioningState                               *ProvisioningState
	Regionality                                     *Regionality
	RequestHeaderOptions                            *ResourceTypeRegistrationPropertiesRequestHeaderOptions
	RequiredFeatures                                []*string
	ResourceDeletionPolicy                          *ResourceDeletionPolicy
	ResourceMovePolicy                              *ResourceTypeRegistrationPropertiesResourceMovePolicy
	RoutingType                                     *RoutingType
	ServiceTreeInfos                                []*ServiceTreeInfo
	SubscriptionLifecycleNotificationSpecifications *ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications
	SubscriptionStateRules                          []*SubscriptionStateRule
	SwaggerSpecifications                           []*SwaggerSpecification
	TemplateDeploymentOptions                       *ResourceTypeRegistrationPropertiesTemplateDeploymentOptions
	ThrottlingRules                                 []*ThrottlingRule
}

func (ResourceTypeRegistrationProperties) MarshalJSON added in v0.2.0

func (r ResourceTypeRegistrationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceTypeRegistrationProperties.

func (*ResourceTypeRegistrationProperties) UnmarshalJSON added in v1.1.0

func (r *ResourceTypeRegistrationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeRegistrationProperties.

type ResourceTypeRegistrationPropertiesAutoGenerated

type ResourceTypeRegistrationPropertiesAutoGenerated struct {
	AllowedUnauthorizedActions                      []*string
	AuthorizationActionMappings                     []*AuthorizationActionMapping
	CheckNameAvailabilitySpecifications             *ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecifications
	DefaultAPIVersion                               *string
	DisallowedActionVerbs                           []*string
	EnableAsyncOperation                            *bool
	EnableThirdPartyS2S                             *bool
	Endpoints                                       []*ResourceTypeEndpoint
	ExtendedLocations                               []*ExtendedLocationOptions
	ExtensionOptions                                *ResourceTypeRegistrationPropertiesExtensionOptions
	FeaturesRule                                    *ResourceTypeRegistrationPropertiesFeaturesRule
	IdentityManagement                              *ResourceTypeRegistrationPropertiesIdentityManagement
	IsPureProxy                                     *bool
	LinkedAccessChecks                              []*LinkedAccessCheck
	LoggingRules                                    []*LoggingRule
	MarketplaceType                                 *ResourceTypeRegistrationPropertiesMarketplaceType
	ProvisioningState                               *ProvisioningState
	Regionality                                     *Regionality
	RequestHeaderOptions                            *ResourceTypeRegistrationPropertiesRequestHeaderOptions
	RequiredFeatures                                []*string
	ResourceDeletionPolicy                          *ResourceDeletionPolicy
	ResourceMovePolicy                              *ResourceTypeRegistrationPropertiesResourceMovePolicy
	RoutingType                                     *RoutingType
	ServiceTreeInfos                                []*ServiceTreeInfo
	SubscriptionLifecycleNotificationSpecifications *ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications
	SubscriptionStateRules                          []*SubscriptionStateRule
	SwaggerSpecifications                           []*SwaggerSpecification
	TemplateDeploymentOptions                       *ResourceTypeRegistrationPropertiesTemplateDeploymentOptions
	ThrottlingRules                                 []*ThrottlingRule
}

func (ResourceTypeRegistrationPropertiesAutoGenerated) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ResourceTypeRegistrationPropertiesAutoGenerated.

func (*ResourceTypeRegistrationPropertiesAutoGenerated) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeRegistrationPropertiesAutoGenerated.

type ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecifications

type ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecifications struct {
	EnableDefaultValidation           *bool
	ResourceTypesWithCustomValidation []*string
}

func (ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecifications) MarshalJSON added in v0.2.0

MarshalJSON implements the json.Marshaller interface for type ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecifications.

func (*ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecifications) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecifications.

type ResourceTypeRegistrationPropertiesExtensionOptions

type ResourceTypeRegistrationPropertiesExtensionOptions struct {
	ResourceCreationBegin *ResourceTypeExtensionOptionsResourceCreationBegin
}

func (ResourceTypeRegistrationPropertiesExtensionOptions) MarshalJSON added in v1.1.0

MarshalJSON implements the json.Marshaller interface for type ResourceTypeRegistrationPropertiesExtensionOptions.

func (*ResourceTypeRegistrationPropertiesExtensionOptions) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeRegistrationPropertiesExtensionOptions.

type ResourceTypeRegistrationPropertiesFeaturesRule

type ResourceTypeRegistrationPropertiesFeaturesRule struct {
	// REQUIRED
	RequiredFeaturesPolicy *FeaturesPolicy
}

func (ResourceTypeRegistrationPropertiesFeaturesRule) MarshalJSON added in v1.1.0

MarshalJSON implements the json.Marshaller interface for type ResourceTypeRegistrationPropertiesFeaturesRule.

func (*ResourceTypeRegistrationPropertiesFeaturesRule) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeRegistrationPropertiesFeaturesRule.

type ResourceTypeRegistrationPropertiesIdentityManagement

type ResourceTypeRegistrationPropertiesIdentityManagement struct {
	ApplicationID *string
	Type          *IdentityManagementTypes
}

func (ResourceTypeRegistrationPropertiesIdentityManagement) MarshalJSON added in v1.1.0

MarshalJSON implements the json.Marshaller interface for type ResourceTypeRegistrationPropertiesIdentityManagement.

func (*ResourceTypeRegistrationPropertiesIdentityManagement) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeRegistrationPropertiesIdentityManagement.

type ResourceTypeRegistrationPropertiesMarketplaceType

type ResourceTypeRegistrationPropertiesMarketplaceType string
const (
	ResourceTypeRegistrationPropertiesMarketplaceTypeAddOn        ResourceTypeRegistrationPropertiesMarketplaceType = "AddOn"
	ResourceTypeRegistrationPropertiesMarketplaceTypeBypass       ResourceTypeRegistrationPropertiesMarketplaceType = "Bypass"
	ResourceTypeRegistrationPropertiesMarketplaceTypeNotSpecified ResourceTypeRegistrationPropertiesMarketplaceType = "NotSpecified"
	ResourceTypeRegistrationPropertiesMarketplaceTypeStore        ResourceTypeRegistrationPropertiesMarketplaceType = "Store"
)

func PossibleResourceTypeRegistrationPropertiesMarketplaceTypeValues

func PossibleResourceTypeRegistrationPropertiesMarketplaceTypeValues() []ResourceTypeRegistrationPropertiesMarketplaceType

PossibleResourceTypeRegistrationPropertiesMarketplaceTypeValues returns the possible values for the ResourceTypeRegistrationPropertiesMarketplaceType const type.

type ResourceTypeRegistrationPropertiesRequestHeaderOptions

type ResourceTypeRegistrationPropertiesRequestHeaderOptions struct {
	OptInHeaders *OptInHeaderType
}

func (ResourceTypeRegistrationPropertiesRequestHeaderOptions) MarshalJSON added in v1.1.0

MarshalJSON implements the json.Marshaller interface for type ResourceTypeRegistrationPropertiesRequestHeaderOptions.

func (*ResourceTypeRegistrationPropertiesRequestHeaderOptions) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeRegistrationPropertiesRequestHeaderOptions.

type ResourceTypeRegistrationPropertiesResourceMovePolicy

type ResourceTypeRegistrationPropertiesResourceMovePolicy struct {
	CrossResourceGroupMoveEnabled *bool
	CrossSubscriptionMoveEnabled  *bool
	ValidationRequired            *bool
}

func (ResourceTypeRegistrationPropertiesResourceMovePolicy) MarshalJSON added in v1.1.0

MarshalJSON implements the json.Marshaller interface for type ResourceTypeRegistrationPropertiesResourceMovePolicy.

func (*ResourceTypeRegistrationPropertiesResourceMovePolicy) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeRegistrationPropertiesResourceMovePolicy.

type ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications

type ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications struct {
	SoftDeleteTTL                    *string
	SubscriptionStateOverrideActions []*SubscriptionStateOverrideAction
}

func (ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications) MarshalJSON added in v0.2.0

MarshalJSON implements the json.Marshaller interface for type ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications.

func (*ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications.

type ResourceTypeRegistrationPropertiesTemplateDeploymentOptions

type ResourceTypeRegistrationPropertiesTemplateDeploymentOptions struct {
	PreflightOptions   []*PreflightOption
	PreflightSupported *bool
}

func (ResourceTypeRegistrationPropertiesTemplateDeploymentOptions) MarshalJSON added in v0.2.0

MarshalJSON implements the json.Marshaller interface for type ResourceTypeRegistrationPropertiesTemplateDeploymentOptions.

func (*ResourceTypeRegistrationPropertiesTemplateDeploymentOptions) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeRegistrationPropertiesTemplateDeploymentOptions.

type ResourceTypeRegistrationsClient

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

ResourceTypeRegistrationsClient contains the methods for the ResourceTypeRegistrations group. Don't use this type directly, use NewResourceTypeRegistrationsClient() instead.

func NewResourceTypeRegistrationsClient

func NewResourceTypeRegistrationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ResourceTypeRegistrationsClient, error)

NewResourceTypeRegistrationsClient creates a new instance of ResourceTypeRegistrationsClient with the specified values.

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

func (*ResourceTypeRegistrationsClient) BeginCreateOrUpdate

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

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • resourceType - The resource type.
  • properties - The required request body parameters supplied to the resource type registration CreateOrUpdate operation.
  • options - ResourceTypeRegistrationsClientBeginCreateOrUpdateOptions contains the optional parameters for the ResourceTypeRegistrationsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/ResourceTypeRegistrations_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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewResourceTypeRegistrationsClient().BeginCreateOrUpdate(ctx, "Microsoft.Contoso", "employees", armproviderhub.ResourceTypeRegistration{
		Properties: &armproviderhub.ResourceTypeRegistrationProperties{
			Endpoints: []*armproviderhub.ResourceTypeEndpoint{
				{
					APIVersions: []*string{
						to.Ptr("2020-06-01-preview")},
					Locations: []*string{
						to.Ptr("West US"),
						to.Ptr("East US"),
						to.Ptr("North Europe")},
					RequiredFeatures: []*string{
						to.Ptr("<feature flag>")},
				}},
			Regionality: to.Ptr(armproviderhub.RegionalityRegional),
			RoutingType: to.Ptr(armproviderhub.RoutingTypeDefault),
			SwaggerSpecifications: []*armproviderhub.SwaggerSpecification{
				{
					APIVersions: []*string{
						to.Ptr("2020-06-01-preview")},
					SwaggerSpecFolderURI: to.Ptr("https://github.com/Azure/azure-rest-api-specs/blob/feature/azure/contoso/specification/contoso/resource-manager/Microsoft.SampleRP/"),
				}},
		},
	}, 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.ResourceTypeRegistration = armproviderhub.ResourceTypeRegistration{
	// 	Name: to.Ptr("employees"),
	// 	Properties: &armproviderhub.ResourceTypeRegistrationProperties{
	// 		EnableAsyncOperation: to.Ptr(false),
	// 		EnableThirdPartyS2S: to.Ptr(false),
	// 		Endpoints: []*armproviderhub.ResourceTypeEndpoint{
	// 			{
	// 				APIVersions: []*string{
	// 					to.Ptr("2018-11-01-preview"),
	// 					to.Ptr("2020-01-01-preview"),
	// 					to.Ptr("2019-01-01")},
	// 					Locations: []*string{
	// 						to.Ptr("East Asia"),
	// 						to.Ptr("East US"),
	// 						to.Ptr("North Europe"),
	// 						to.Ptr("Southeast Asia"),
	// 						to.Ptr("East US 2 EUAP"),
	// 						to.Ptr("Central US EUAP"),
	// 						to.Ptr("West Europe"),
	// 						to.Ptr("West US"),
	// 						to.Ptr("West Central US"),
	// 						to.Ptr("West US 2")},
	// 						RequiredFeatures: []*string{
	// 							to.Ptr("Microsoft.Contoso/RPaaSSampleApp")},
	// 					}},
	// 					ProvisioningState: to.Ptr(armproviderhub.ProvisioningStateSucceeded),
	// 					Regionality: to.Ptr(armproviderhub.RegionalityRegional),
	// 					ResourceDeletionPolicy: to.Ptr(armproviderhub.ResourceDeletionPolicyCascadeDeleteProxyOnlyChildren),
	// 					RoutingType: to.Ptr(armproviderhub.RoutingTypeDefault),
	// 					SwaggerSpecifications: []*armproviderhub.SwaggerSpecification{
	// 						{
	// 							APIVersions: []*string{
	// 								to.Ptr("2018-11-01-preview"),
	// 								to.Ptr("2020-01-01-preview"),
	// 								to.Ptr("2019-01-01")},
	// 								SwaggerSpecFolderURI: to.Ptr("https://github.com/Azure/azure-rest-api-specs/blob/feature/azure/contoso/specification/contoso/resource-manager/Microsoft.SampleRP/"),
	// 						}},
	// 					},
	// 				}
}
Output:

func (*ResourceTypeRegistrationsClient) Delete

Delete - Deletes a resource type If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • resourceType - The resource type.
  • options - ResourceTypeRegistrationsClientDeleteOptions contains the optional parameters for the ResourceTypeRegistrationsClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/ResourceTypeRegistrations_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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewResourceTypeRegistrationsClient().Delete(ctx, "Microsoft.Contoso", "testResourceType", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*ResourceTypeRegistrationsClient) Get

Get - Gets a resource type details in the given subscription and provider. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • resourceType - The resource type.
  • options - ResourceTypeRegistrationsClientGetOptions contains the optional parameters for the ResourceTypeRegistrationsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/ResourceTypeRegistrations_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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewResourceTypeRegistrationsClient().Get(ctx, "Microsoft.Contoso", "employees", 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.ResourceTypeRegistration = armproviderhub.ResourceTypeRegistration{
	// 	Name: to.Ptr("employees"),
	// 	Properties: &armproviderhub.ResourceTypeRegistrationProperties{
	// 		EnableAsyncOperation: to.Ptr(false),
	// 		EnableThirdPartyS2S: to.Ptr(false),
	// 		Endpoints: []*armproviderhub.ResourceTypeEndpoint{
	// 			{
	// 				APIVersions: []*string{
	// 					to.Ptr("2018-11-01-preview"),
	// 					to.Ptr("2020-01-01-preview"),
	// 					to.Ptr("2019-01-01")},
	// 					Locations: []*string{
	// 						to.Ptr("East Asia"),
	// 						to.Ptr("East US"),
	// 						to.Ptr("North Europe"),
	// 						to.Ptr("Southeast Asia"),
	// 						to.Ptr("East US 2 EUAP"),
	// 						to.Ptr("Central US EUAP"),
	// 						to.Ptr("West Europe"),
	// 						to.Ptr("West US"),
	// 						to.Ptr("West Central US"),
	// 						to.Ptr("West US 2")},
	// 						RequiredFeatures: []*string{
	// 							to.Ptr("Microsoft.Contoso/RPaaSSampleApp")},
	// 					}},
	// 					ProvisioningState: to.Ptr(armproviderhub.ProvisioningStateSucceeded),
	// 					Regionality: to.Ptr(armproviderhub.RegionalityRegional),
	// 					RoutingType: to.Ptr(armproviderhub.RoutingTypeDefault),
	// 					SwaggerSpecifications: []*armproviderhub.SwaggerSpecification{
	// 						{
	// 							APIVersions: []*string{
	// 								to.Ptr("2018-11-01-preview"),
	// 								to.Ptr("2020-01-01-preview"),
	// 								to.Ptr("2019-01-01")},
	// 								SwaggerSpecFolderURI: to.Ptr("https://github.com/Azure/azure-rest-api-specs/blob/feature/azure/contoso/specification/contoso/resource-manager/Microsoft.SampleRP/"),
	// 						}},
	// 					},
	// 				}
}
Output:

func (*ResourceTypeRegistrationsClient) NewListByProviderRegistrationPager added in v0.4.0

NewListByProviderRegistrationPager - Gets the list of the resource types for the given provider.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • options - ResourceTypeRegistrationsClientListByProviderRegistrationOptions contains the optional parameters for the ResourceTypeRegistrationsClient.NewListByProviderRegistrationPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/ResourceTypeRegistrations_ListByProviderRegistration.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewResourceTypeRegistrationsClient().NewListByProviderRegistrationPager("Microsoft.Contoso", 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.ResourceTypeRegistrationArrayResponseWithContinuation = armproviderhub.ResourceTypeRegistrationArrayResponseWithContinuation{
		// 	Value: []*armproviderhub.ResourceTypeRegistration{
		// 		{
		// 			Name: to.Ptr("employees"),
		// 			Properties: &armproviderhub.ResourceTypeRegistrationProperties{
		// 				EnableAsyncOperation: to.Ptr(false),
		// 				EnableThirdPartyS2S: to.Ptr(false),
		// 				Endpoints: []*armproviderhub.ResourceTypeEndpoint{
		// 					{
		// 						APIVersions: []*string{
		// 							to.Ptr("2018-11-01-preview"),
		// 							to.Ptr("2020-01-01-preview"),
		// 							to.Ptr("2019-01-01")},
		// 							Locations: []*string{
		// 								to.Ptr("East Asia"),
		// 								to.Ptr("East US"),
		// 								to.Ptr("North Europe"),
		// 								to.Ptr("Southeast Asia"),
		// 								to.Ptr("East US 2 EUAP"),
		// 								to.Ptr("Central US EUAP"),
		// 								to.Ptr("West Europe"),
		// 								to.Ptr("West US"),
		// 								to.Ptr("West Central US"),
		// 								to.Ptr("West US 2")},
		// 								RequiredFeatures: []*string{
		// 									to.Ptr("Microsoft.Contoso/RPaaSSampleApp")},
		// 							}},
		// 							ProvisioningState: to.Ptr(armproviderhub.ProvisioningStateSucceeded),
		// 							Regionality: to.Ptr(armproviderhub.RegionalityRegional),
		// 							RoutingType: to.Ptr(armproviderhub.RoutingTypeDefault),
		// 							SwaggerSpecifications: []*armproviderhub.SwaggerSpecification{
		// 								{
		// 									APIVersions: []*string{
		// 										to.Ptr("2018-11-01-preview"),
		// 										to.Ptr("2020-01-01-preview"),
		// 										to.Ptr("2019-01-01")},
		// 										SwaggerSpecFolderURI: to.Ptr("https://github.com/Azure/azure-rest-api-specs/blob/feature/azure/contoso/specification/contoso/resource-manager/Microsoft.SampleRP/"),
		// 								}},
		// 							},
		// 					}},
		// 				}
	}
}
Output:

type ResourceTypeRegistrationsClientBeginCreateOrUpdateOptions added in v0.2.0

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

ResourceTypeRegistrationsClientBeginCreateOrUpdateOptions contains the optional parameters for the ResourceTypeRegistrationsClient.BeginCreateOrUpdate method.

type ResourceTypeRegistrationsClientCreateOrUpdateResponse added in v0.2.0

type ResourceTypeRegistrationsClientCreateOrUpdateResponse struct {
	ResourceTypeRegistration
}

ResourceTypeRegistrationsClientCreateOrUpdateResponse contains the response from method ResourceTypeRegistrationsClient.BeginCreateOrUpdate.

type ResourceTypeRegistrationsClientDeleteOptions added in v0.2.0

type ResourceTypeRegistrationsClientDeleteOptions struct {
}

ResourceTypeRegistrationsClientDeleteOptions contains the optional parameters for the ResourceTypeRegistrationsClient.Delete method.

type ResourceTypeRegistrationsClientDeleteResponse added in v0.2.0

type ResourceTypeRegistrationsClientDeleteResponse struct {
}

ResourceTypeRegistrationsClientDeleteResponse contains the response from method ResourceTypeRegistrationsClient.Delete.

type ResourceTypeRegistrationsClientGetOptions added in v0.2.0

type ResourceTypeRegistrationsClientGetOptions struct {
}

ResourceTypeRegistrationsClientGetOptions contains the optional parameters for the ResourceTypeRegistrationsClient.Get method.

type ResourceTypeRegistrationsClientGetResponse added in v0.2.0

type ResourceTypeRegistrationsClientGetResponse struct {
	ResourceTypeRegistration
}

ResourceTypeRegistrationsClientGetResponse contains the response from method ResourceTypeRegistrationsClient.Get.

type ResourceTypeRegistrationsClientListByProviderRegistrationOptions added in v0.2.0

type ResourceTypeRegistrationsClientListByProviderRegistrationOptions struct {
}

ResourceTypeRegistrationsClientListByProviderRegistrationOptions contains the optional parameters for the ResourceTypeRegistrationsClient.NewListByProviderRegistrationPager method.

type ResourceTypeRegistrationsClientListByProviderRegistrationResponse added in v0.2.0

type ResourceTypeRegistrationsClientListByProviderRegistrationResponse struct {
	ResourceTypeRegistrationArrayResponseWithContinuation
}

ResourceTypeRegistrationsClientListByProviderRegistrationResponse contains the response from method ResourceTypeRegistrationsClient.NewListByProviderRegistrationPager.

type ResourceTypeRequestHeaderOptions

type ResourceTypeRequestHeaderOptions struct {
	OptInHeaders *OptInHeaderType
}

func (ResourceTypeRequestHeaderOptions) MarshalJSON added in v1.1.0

func (r ResourceTypeRequestHeaderOptions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceTypeRequestHeaderOptions.

func (*ResourceTypeRequestHeaderOptions) UnmarshalJSON added in v1.1.0

func (r *ResourceTypeRequestHeaderOptions) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeRequestHeaderOptions.

type ResourceTypeSKU

type ResourceTypeSKU struct {
	// REQUIRED
	SKUSettings       []*SKUSetting
	ProvisioningState *ProvisioningState
}

func (ResourceTypeSKU) MarshalJSON

func (r ResourceTypeSKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceTypeSKU.

func (*ResourceTypeSKU) UnmarshalJSON added in v1.1.0

func (r *ResourceTypeSKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeSKU.

type ResourceTypeTemplateDeploymentPolicy

type ResourceTypeTemplateDeploymentPolicy struct {
	// REQUIRED
	Capabilities *TemplateDeploymentCapabilities

	// REQUIRED
	PreflightOptions *TemplateDeploymentPreflightOptions
}

func (ResourceTypeTemplateDeploymentPolicy) MarshalJSON added in v1.1.0

func (r ResourceTypeTemplateDeploymentPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceTypeTemplateDeploymentPolicy.

func (*ResourceTypeTemplateDeploymentPolicy) UnmarshalJSON added in v1.1.0

func (r *ResourceTypeTemplateDeploymentPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeTemplateDeploymentPolicy.

type ResourceValidation

type ResourceValidation string
const (
	ResourceValidationNotSpecified  ResourceValidation = "NotSpecified"
	ResourceValidationProfaneWords  ResourceValidation = "ProfaneWords"
	ResourceValidationReservedWords ResourceValidation = "ReservedWords"
)

func PossibleResourceValidationValues

func PossibleResourceValidationValues() []ResourceValidation

PossibleResourceValidationValues returns the possible values for the ResourceValidation const type.

type RolloutStatusBase

type RolloutStatusBase struct {
	CompletedRegions []*string

	// Dictionary of
	FailedOrSkippedRegions map[string]*ExtendedErrorInfo
}

func (RolloutStatusBase) MarshalJSON

func (r RolloutStatusBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RolloutStatusBase.

func (*RolloutStatusBase) UnmarshalJSON

func (r *RolloutStatusBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RolloutStatusBase.

type RoutingType

type RoutingType string
const (
	RoutingTypeCascadeExtension RoutingType = "CascadeExtension"
	RoutingTypeDefault          RoutingType = "Default"
	RoutingTypeExtension        RoutingType = "Extension"
	RoutingTypeFailover         RoutingType = "Failover"
	RoutingTypeFanout           RoutingType = "Fanout"
	RoutingTypeHostBased        RoutingType = "HostBased"
	RoutingTypeLocationBased    RoutingType = "LocationBased"
	RoutingTypeProxyOnly        RoutingType = "ProxyOnly"
	RoutingTypeTenant           RoutingType = "Tenant"
)

func PossibleRoutingTypeValues

func PossibleRoutingTypeValues() []RoutingType

PossibleRoutingTypeValues returns the possible values for the RoutingType const type.

type SKUCapability

type SKUCapability struct {
	// REQUIRED
	Name *string

	// REQUIRED
	Value *string
}

func (SKUCapability) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type SKUCapability.

func (*SKUCapability) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type SKUCapability.

type SKUCapacity

type SKUCapacity struct {
	// REQUIRED
	Minimum   *int32
	Default   *int32
	Maximum   *int32
	ScaleType *SKUScaleType
}

func (SKUCapacity) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type SKUCapacity.

func (*SKUCapacity) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type SKUCapacity.

type SKUCost

type SKUCost struct {
	// REQUIRED
	MeterID      *string
	ExtendedUnit *string
	Quantity     *int32
}

func (SKUCost) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type SKUCost.

func (*SKUCost) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type SKUCost.

type SKULocationInfo

type SKULocationInfo struct {
	// REQUIRED
	Location          *string
	ExtendedLocations []*string
	Type              *SKULocationInfoType
	ZoneDetails       []*SKUZoneDetail
	Zones             []*string
}

func (SKULocationInfo) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SKULocationInfo.

func (*SKULocationInfo) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type SKULocationInfo.

type SKULocationInfoType

type SKULocationInfoType string
const (
	SKULocationInfoTypeArcZone      SKULocationInfoType = "ArcZone"
	SKULocationInfoTypeEdgeZone     SKULocationInfoType = "EdgeZone"
	SKULocationInfoTypeNotSpecified SKULocationInfoType = "NotSpecified"
)

func PossibleSKULocationInfoTypeValues

func PossibleSKULocationInfoTypeValues() []SKULocationInfoType

PossibleSKULocationInfoTypeValues returns the possible values for the SKULocationInfoType const type.

type SKUResource

type SKUResource struct {
	Properties *SKUResourceProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

func (SKUResource) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type SKUResource.

func (*SKUResource) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type SKUResource.

type SKUResourceArrayResponseWithContinuation

type SKUResourceArrayResponseWithContinuation struct {
	// The URL to get to the next set of results, if there are any.
	NextLink *string
	Value    []*SKUResource
}

func (SKUResourceArrayResponseWithContinuation) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type SKUResourceArrayResponseWithContinuation.

func (*SKUResourceArrayResponseWithContinuation) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type SKUResourceArrayResponseWithContinuation.

type SKUResourceProperties

type SKUResourceProperties struct {
	// REQUIRED
	SKUSettings       []*SKUSetting
	ProvisioningState *ProvisioningState
}

func (SKUResourceProperties) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type SKUResourceProperties.

func (*SKUResourceProperties) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type SKUResourceProperties.

type SKUScaleType

type SKUScaleType string
const (
	SKUScaleTypeAutomatic SKUScaleType = "Automatic"
	SKUScaleTypeManual    SKUScaleType = "Manual"
	SKUScaleTypeNone      SKUScaleType = "None"
)

func PossibleSKUScaleTypeValues

func PossibleSKUScaleTypeValues() []SKUScaleType

PossibleSKUScaleTypeValues returns the possible values for the SKUScaleType const type.

type SKUSetting

type SKUSetting struct {
	// REQUIRED
	Name             *string
	Capabilities     []*SKUCapability
	Capacity         *SKUSettingCapacity
	Costs            []*SKUCost
	Family           *string
	Kind             *string
	LocationInfo     []*SKULocationInfo
	Locations        []*string
	RequiredFeatures []*string
	RequiredQuotaIDs []*string
	Size             *string
	Tier             *string
}

func (SKUSetting) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SKUSetting.

func (*SKUSetting) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type SKUSetting.

type SKUSettingCapacity

type SKUSettingCapacity struct {
	// REQUIRED
	Minimum   *int32
	Default   *int32
	Maximum   *int32
	ScaleType *SKUScaleType
}

func (SKUSettingCapacity) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type SKUSettingCapacity.

func (*SKUSettingCapacity) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type SKUSettingCapacity.

type SKUZoneDetail

type SKUZoneDetail struct {
	Capabilities []*SKUCapability
	Name         []*string
}

func (SKUZoneDetail) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SKUZoneDetail.

func (*SKUZoneDetail) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type SKUZoneDetail.

type SKUsClient

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

SKUsClient contains the methods for the SKUs group. Don't use this type directly, use NewSKUsClient() instead.

func NewSKUsClient

func NewSKUsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SKUsClient, error)

NewSKUsClient creates a new instance of SKUsClient with the specified values.

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

func (*SKUsClient) CreateOrUpdate

func (client *SKUsClient) CreateOrUpdate(ctx context.Context, providerNamespace string, resourceType string, sku string, properties SKUResource, options *SKUsClientCreateOrUpdateOptions) (SKUsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates the resource type skus in the given resource type. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • resourceType - The resource type.
  • sku - The SKU.
  • properties - The required body parameters supplied to the resource sku operation.
  • options - SKUsClientCreateOrUpdateOptions contains the optional parameters for the SKUsClient.CreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Skus_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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSKUsClient().CreateOrUpdate(ctx, "Microsoft.Contoso", "testResourceType", "testSku", armproviderhub.SKUResource{
		Properties: &armproviderhub.SKUResourceProperties{
			SKUSettings: []*armproviderhub.SKUSetting{
				{
					Name: to.Ptr("freeSku"),
					Kind: to.Ptr("Standard"),
					Tier: to.Ptr("Tier1"),
				},
				{
					Name: to.Ptr("premiumSku"),
					Costs: []*armproviderhub.SKUCost{
						{
							MeterID: to.Ptr("xxx"),
						}},
					Kind: to.Ptr("Premium"),
					Tier: to.Ptr("Tier2"),
				}},
		},
	}, 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.SKUResource = armproviderhub.SKUResource{
	// 	Name: to.Ptr("Microsoft.Contoso/"),
	// 	Type: to.Ptr("Microsoft.ProviderHub/providerRegistrations/"),
	// 	ID: to.Ptr("/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/"),
	// }
}
Output:

func (*SKUsClient) CreateOrUpdateNestedResourceTypeFirst

func (client *SKUsClient) CreateOrUpdateNestedResourceTypeFirst(ctx context.Context, providerNamespace string, resourceType string, nestedResourceTypeFirst string, sku string, properties SKUResource, options *SKUsClientCreateOrUpdateNestedResourceTypeFirstOptions) (SKUsClientCreateOrUpdateNestedResourceTypeFirstResponse, error)

CreateOrUpdateNestedResourceTypeFirst - Creates or updates the resource type skus in the given resource type. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • resourceType - The resource type.
  • nestedResourceTypeFirst - The first child resource type.
  • sku - The SKU.
  • properties - The required body parameters supplied to the resource sku operation.
  • options - SKUsClientCreateOrUpdateNestedResourceTypeFirstOptions contains the optional parameters for the SKUsClient.CreateOrUpdateNestedResourceTypeFirst method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Skus_CreateOrUpdateNestedResourceTypeFirst.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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSKUsClient().CreateOrUpdateNestedResourceTypeFirst(ctx, "Microsoft.Contoso", "testResourceType", "nestedResourceTypeFirst", "testSku", armproviderhub.SKUResource{
		Properties: &armproviderhub.SKUResourceProperties{
			SKUSettings: []*armproviderhub.SKUSetting{
				{
					Name: to.Ptr("freeSku"),
					Kind: to.Ptr("Standard"),
					Tier: to.Ptr("Tier1"),
				},
				{
					Name: to.Ptr("premiumSku"),
					Costs: []*armproviderhub.SKUCost{
						{
							MeterID: to.Ptr("xxx"),
						}},
					Kind: to.Ptr("Premium"),
					Tier: to.Ptr("Tier2"),
				}},
		},
	}, 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.SKUResource = armproviderhub.SKUResource{
	// 	Name: to.Ptr("Microsoft.Contoso/"),
	// 	Type: to.Ptr("Microsoft.ProviderHub/providerRegistrations/"),
	// 	ID: to.Ptr("/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/"),
	// }
}
Output:

func (*SKUsClient) CreateOrUpdateNestedResourceTypeSecond

func (client *SKUsClient) CreateOrUpdateNestedResourceTypeSecond(ctx context.Context, providerNamespace string, resourceType string, nestedResourceTypeFirst string, nestedResourceTypeSecond string, sku string, properties SKUResource, options *SKUsClientCreateOrUpdateNestedResourceTypeSecondOptions) (SKUsClientCreateOrUpdateNestedResourceTypeSecondResponse, error)

CreateOrUpdateNestedResourceTypeSecond - Creates or updates the resource type skus in the given resource type. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • resourceType - The resource type.
  • nestedResourceTypeFirst - The first child resource type.
  • nestedResourceTypeSecond - The second child resource type.
  • sku - The SKU.
  • properties - The required body parameters supplied to the resource sku operation.
  • options - SKUsClientCreateOrUpdateNestedResourceTypeSecondOptions contains the optional parameters for the SKUsClient.CreateOrUpdateNestedResourceTypeSecond method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Skus_CreateOrUpdateNestedResourceTypeSecond.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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSKUsClient().CreateOrUpdateNestedResourceTypeSecond(ctx, "Microsoft.Contoso", "testResourceType", "nestedResourceTypeFirst", "nestedResourceTypeSecond", "testSku", armproviderhub.SKUResource{
		Properties: &armproviderhub.SKUResourceProperties{
			SKUSettings: []*armproviderhub.SKUSetting{
				{
					Name: to.Ptr("freeSku"),
					Kind: to.Ptr("Standard"),
					Tier: to.Ptr("Tier1"),
				},
				{
					Name: to.Ptr("premiumSku"),
					Costs: []*armproviderhub.SKUCost{
						{
							MeterID: to.Ptr("xxx"),
						}},
					Kind: to.Ptr("Premium"),
					Tier: to.Ptr("Tier2"),
				}},
		},
	}, 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.SKUResource = armproviderhub.SKUResource{
	// 	Name: to.Ptr("Microsoft.Contoso/"),
	// 	Type: to.Ptr("Microsoft.ProviderHub/providerRegistrations/"),
	// 	ID: to.Ptr("/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/"),
	// }
}
Output:

func (*SKUsClient) CreateOrUpdateNestedResourceTypeThird

func (client *SKUsClient) CreateOrUpdateNestedResourceTypeThird(ctx context.Context, providerNamespace string, resourceType string, nestedResourceTypeFirst string, nestedResourceTypeSecond string, nestedResourceTypeThird string, sku string, properties SKUResource, options *SKUsClientCreateOrUpdateNestedResourceTypeThirdOptions) (SKUsClientCreateOrUpdateNestedResourceTypeThirdResponse, error)

CreateOrUpdateNestedResourceTypeThird - Creates or updates the resource type skus in the given resource type. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • resourceType - The resource type.
  • nestedResourceTypeFirst - The first child resource type.
  • nestedResourceTypeSecond - The second child resource type.
  • nestedResourceTypeThird - The third child resource type.
  • sku - The SKU.
  • properties - The required body parameters supplied to the resource sku operation.
  • options - SKUsClientCreateOrUpdateNestedResourceTypeThirdOptions contains the optional parameters for the SKUsClient.CreateOrUpdateNestedResourceTypeThird method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Skus_CreateOrUpdateNestedResourceTypeThird.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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSKUsClient().CreateOrUpdateNestedResourceTypeThird(ctx, "Microsoft.Contoso", "testResourceType", "nestedResourceTypeFirst", "nestedResourceTypeSecond", "nestedResourceTypeThird", "testSku", armproviderhub.SKUResource{
		Properties: &armproviderhub.SKUResourceProperties{
			SKUSettings: []*armproviderhub.SKUSetting{
				{
					Name: to.Ptr("freeSku"),
					Kind: to.Ptr("Standard"),
					Tier: to.Ptr("Tier1"),
				},
				{
					Name: to.Ptr("premiumSku"),
					Costs: []*armproviderhub.SKUCost{
						{
							MeterID: to.Ptr("xxx"),
						}},
					Kind: to.Ptr("Premium"),
					Tier: to.Ptr("Tier2"),
				}},
		},
	}, 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.SKUResource = armproviderhub.SKUResource{
	// 	Name: to.Ptr("Microsoft.Contoso/"),
	// 	Type: to.Ptr("Microsoft.ProviderHub/providerRegistrations/"),
	// 	ID: to.Ptr("/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/"),
	// }
}
Output:

func (*SKUsClient) Delete

func (client *SKUsClient) Delete(ctx context.Context, providerNamespace string, resourceType string, sku string, options *SKUsClientDeleteOptions) (SKUsClientDeleteResponse, error)

Delete - Deletes a resource type sku. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • resourceType - The resource type.
  • sku - The SKU.
  • options - SKUsClientDeleteOptions contains the optional parameters for the SKUsClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Skus_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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewSKUsClient().Delete(ctx, "Microsoft.Contoso", "testResourceType", "testSku", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*SKUsClient) DeleteNestedResourceTypeFirst

func (client *SKUsClient) DeleteNestedResourceTypeFirst(ctx context.Context, providerNamespace string, resourceType string, nestedResourceTypeFirst string, sku string, options *SKUsClientDeleteNestedResourceTypeFirstOptions) (SKUsClientDeleteNestedResourceTypeFirstResponse, error)

DeleteNestedResourceTypeFirst - Deletes a resource type sku. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • resourceType - The resource type.
  • nestedResourceTypeFirst - The first child resource type.
  • sku - The SKU.
  • options - SKUsClientDeleteNestedResourceTypeFirstOptions contains the optional parameters for the SKUsClient.DeleteNestedResourceTypeFirst method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Skus_DeleteNestedResourceTypeFirst.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewSKUsClient().DeleteNestedResourceTypeFirst(ctx, "Microsoft.Contoso", "testResourceType", "nestedResourceTypeFirst", "testSku", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*SKUsClient) DeleteNestedResourceTypeSecond

func (client *SKUsClient) DeleteNestedResourceTypeSecond(ctx context.Context, providerNamespace string, resourceType string, nestedResourceTypeFirst string, nestedResourceTypeSecond string, sku string, options *SKUsClientDeleteNestedResourceTypeSecondOptions) (SKUsClientDeleteNestedResourceTypeSecondResponse, error)

DeleteNestedResourceTypeSecond - Deletes a resource type sku. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • resourceType - The resource type.
  • nestedResourceTypeFirst - The first child resource type.
  • nestedResourceTypeSecond - The second child resource type.
  • sku - The SKU.
  • options - SKUsClientDeleteNestedResourceTypeSecondOptions contains the optional parameters for the SKUsClient.DeleteNestedResourceTypeSecond method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Skus_DeleteNestedResourceTypeSecond.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewSKUsClient().DeleteNestedResourceTypeSecond(ctx, "Microsoft.Contoso", "testResourceType", "nestedResourceTypeFirst", "nestedResourceTypeSecond", "testSku", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*SKUsClient) DeleteNestedResourceTypeThird

func (client *SKUsClient) DeleteNestedResourceTypeThird(ctx context.Context, providerNamespace string, resourceType string, nestedResourceTypeFirst string, nestedResourceTypeSecond string, nestedResourceTypeThird string, sku string, options *SKUsClientDeleteNestedResourceTypeThirdOptions) (SKUsClientDeleteNestedResourceTypeThirdResponse, error)

DeleteNestedResourceTypeThird - Deletes a resource type sku. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • resourceType - The resource type.
  • nestedResourceTypeFirst - The first child resource type.
  • nestedResourceTypeSecond - The second child resource type.
  • nestedResourceTypeThird - The third child resource type.
  • sku - The SKU.
  • options - SKUsClientDeleteNestedResourceTypeThirdOptions contains the optional parameters for the SKUsClient.DeleteNestedResourceTypeThird method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Skus_DeleteNestedResourceTypeThird.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewSKUsClient().DeleteNestedResourceTypeThird(ctx, "Microsoft.Contoso", "testResourceType", "nestedResourceTypeFirst", "nestedResourceTypeSecond", "nestedResourceTypeThird", "testSku", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*SKUsClient) Get

func (client *SKUsClient) Get(ctx context.Context, providerNamespace string, resourceType string, sku string, options *SKUsClientGetOptions) (SKUsClientGetResponse, error)

Get - Gets the sku details for the given resource type and sku name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • resourceType - The resource type.
  • sku - The SKU.
  • options - SKUsClientGetOptions contains the optional parameters for the SKUsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Skus_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/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSKUsClient().Get(ctx, "Microsoft.Contoso", "testResourceType", "testSku", 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.SKUResource = armproviderhub.SKUResource{
	// 	Name: to.Ptr("testSku"),
	// 	Properties: &armproviderhub.SKUResourceProperties{
	// 		SKUSettings: []*armproviderhub.SKUSetting{
	// 			{
	// 				Name: to.Ptr("freeSku"),
	// 				Kind: to.Ptr("Standard"),
	// 				Tier: to.Ptr("Tier1"),
	// 			},
	// 			{
	// 				Name: to.Ptr("premiumSku"),
	// 				Costs: []*armproviderhub.SKUCost{
	// 					{
	// 						MeterID: to.Ptr("xxx"),
	// 				}},
	// 				Kind: to.Ptr("Premium"),
	// 				Tier: to.Ptr("Tier2"),
	// 		}},
	// 	},
	// }
}
Output:

func (*SKUsClient) GetNestedResourceTypeFirst

func (client *SKUsClient) GetNestedResourceTypeFirst(ctx context.Context, providerNamespace string, resourceType string, nestedResourceTypeFirst string, sku string, options *SKUsClientGetNestedResourceTypeFirstOptions) (SKUsClientGetNestedResourceTypeFirstResponse, error)

GetNestedResourceTypeFirst - Gets the sku details for the given resource type and sku name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • resourceType - The resource type.
  • nestedResourceTypeFirst - The first child resource type.
  • sku - The SKU.
  • options - SKUsClientGetNestedResourceTypeFirstOptions contains the optional parameters for the SKUsClient.GetNestedResourceTypeFirst method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Skus_GetNestedResourceTypeFirst.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSKUsClient().GetNestedResourceTypeFirst(ctx, "Microsoft.Contoso", "testResourceType", "nestedResourceTypeFirst", "testSku", 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.SKUResource = armproviderhub.SKUResource{
	// 	Name: to.Ptr("testSku"),
	// 	Properties: &armproviderhub.SKUResourceProperties{
	// 		SKUSettings: []*armproviderhub.SKUSetting{
	// 			{
	// 				Name: to.Ptr("freeSku"),
	// 				Kind: to.Ptr("Standard"),
	// 				Tier: to.Ptr("Tier1"),
	// 			},
	// 			{
	// 				Name: to.Ptr("premiumSku"),
	// 				Costs: []*armproviderhub.SKUCost{
	// 					{
	// 						MeterID: to.Ptr("xxx"),
	// 				}},
	// 				Kind: to.Ptr("Premium"),
	// 				Tier: to.Ptr("Tier2"),
	// 		}},
	// 	},
	// }
}
Output:

func (*SKUsClient) GetNestedResourceTypeSecond

func (client *SKUsClient) GetNestedResourceTypeSecond(ctx context.Context, providerNamespace string, resourceType string, nestedResourceTypeFirst string, nestedResourceTypeSecond string, sku string, options *SKUsClientGetNestedResourceTypeSecondOptions) (SKUsClientGetNestedResourceTypeSecondResponse, error)

GetNestedResourceTypeSecond - Gets the sku details for the given resource type and sku name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • resourceType - The resource type.
  • nestedResourceTypeFirst - The first child resource type.
  • nestedResourceTypeSecond - The second child resource type.
  • sku - The SKU.
  • options - SKUsClientGetNestedResourceTypeSecondOptions contains the optional parameters for the SKUsClient.GetNestedResourceTypeSecond method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Skus_GetNestedResourceTypeSecond.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSKUsClient().GetNestedResourceTypeSecond(ctx, "Microsoft.Contoso", "testResourceType", "nestedResourceTypeFirst", "nestedResourceTypeSecond", "testSku", 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.SKUResource = armproviderhub.SKUResource{
	// 	Name: to.Ptr("testSku"),
	// 	Properties: &armproviderhub.SKUResourceProperties{
	// 		SKUSettings: []*armproviderhub.SKUSetting{
	// 			{
	// 				Name: to.Ptr("freeSku"),
	// 				Kind: to.Ptr("Standard"),
	// 				Tier: to.Ptr("Tier1"),
	// 			},
	// 			{
	// 				Name: to.Ptr("premiumSku"),
	// 				Costs: []*armproviderhub.SKUCost{
	// 					{
	// 						MeterID: to.Ptr("xxx"),
	// 				}},
	// 				Kind: to.Ptr("Premium"),
	// 				Tier: to.Ptr("Tier2"),
	// 		}},
	// 	},
	// }
}
Output:

func (*SKUsClient) GetNestedResourceTypeThird

func (client *SKUsClient) GetNestedResourceTypeThird(ctx context.Context, providerNamespace string, resourceType string, nestedResourceTypeFirst string, nestedResourceTypeSecond string, nestedResourceTypeThird string, sku string, options *SKUsClientGetNestedResourceTypeThirdOptions) (SKUsClientGetNestedResourceTypeThirdResponse, error)

GetNestedResourceTypeThird - Gets the sku details for the given resource type and sku name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • resourceType - The resource type.
  • nestedResourceTypeFirst - The first child resource type.
  • nestedResourceTypeSecond - The second child resource type.
  • nestedResourceTypeThird - The third child resource type.
  • sku - The SKU.
  • options - SKUsClientGetNestedResourceTypeThirdOptions contains the optional parameters for the SKUsClient.GetNestedResourceTypeThird method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Skus_GetNestedResourceTypeThird.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSKUsClient().GetNestedResourceTypeThird(ctx, "Microsoft.Contoso", "testResourceType", "nestedResourceTypeFirst", "nestedResourceTypeSecond", "nestedResourceTypeThird", "testSku", 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.SKUResource = armproviderhub.SKUResource{
	// 	Name: to.Ptr("testSku"),
	// 	Properties: &armproviderhub.SKUResourceProperties{
	// 		SKUSettings: []*armproviderhub.SKUSetting{
	// 			{
	// 				Name: to.Ptr("freeSku"),
	// 				Kind: to.Ptr("Standard"),
	// 				Tier: to.Ptr("Tier1"),
	// 			},
	// 			{
	// 				Name: to.Ptr("premiumSku"),
	// 				Costs: []*armproviderhub.SKUCost{
	// 					{
	// 						MeterID: to.Ptr("xxx"),
	// 				}},
	// 				Kind: to.Ptr("Premium"),
	// 				Tier: to.Ptr("Tier2"),
	// 		}},
	// 	},
	// }
}
Output:

func (*SKUsClient) NewListByResourceTypeRegistrationsNestedResourceTypeFirstPager added in v0.4.0

func (client *SKUsClient) NewListByResourceTypeRegistrationsNestedResourceTypeFirstPager(providerNamespace string, resourceType string, nestedResourceTypeFirst string, options *SKUsClientListByResourceTypeRegistrationsNestedResourceTypeFirstOptions) *runtime.Pager[SKUsClientListByResourceTypeRegistrationsNestedResourceTypeFirstResponse]

NewListByResourceTypeRegistrationsNestedResourceTypeFirstPager - Gets the list of skus for the given resource type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • resourceType - The resource type.
  • nestedResourceTypeFirst - The first child resource type.
  • options - SKUsClientListByResourceTypeRegistrationsNestedResourceTypeFirstOptions contains the optional parameters for the SKUsClient.NewListByResourceTypeRegistrationsNestedResourceTypeFirstPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeFirst.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSKUsClient().NewListByResourceTypeRegistrationsNestedResourceTypeFirstPager("Microsoft.Contoso", "testResourceType", "nestedResourceTypeFirst", 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.SKUResourceArrayResponseWithContinuation = armproviderhub.SKUResourceArrayResponseWithContinuation{
		// 	Value: []*armproviderhub.SKUResource{
		// 		{
		// 			Name: to.Ptr("testSku"),
		// 			Properties: &armproviderhub.SKUResourceProperties{
		// 				SKUSettings: []*armproviderhub.SKUSetting{
		// 					{
		// 						Name: to.Ptr("freeSku"),
		// 						Kind: to.Ptr("Standard"),
		// 						Tier: to.Ptr("Tier1"),
		// 					},
		// 					{
		// 						Name: to.Ptr("premiumSku"),
		// 						Costs: []*armproviderhub.SKUCost{
		// 							{
		// 								MeterID: to.Ptr("xxx"),
		// 						}},
		// 						Kind: to.Ptr("Premium"),
		// 						Tier: to.Ptr("Tier2"),
		// 				}},
		// 			},
		// 	}},
		// }
	}
}
Output:

func (*SKUsClient) NewListByResourceTypeRegistrationsNestedResourceTypeSecondPager added in v0.4.0

func (client *SKUsClient) NewListByResourceTypeRegistrationsNestedResourceTypeSecondPager(providerNamespace string, resourceType string, nestedResourceTypeFirst string, nestedResourceTypeSecond string, options *SKUsClientListByResourceTypeRegistrationsNestedResourceTypeSecondOptions) *runtime.Pager[SKUsClientListByResourceTypeRegistrationsNestedResourceTypeSecondResponse]

NewListByResourceTypeRegistrationsNestedResourceTypeSecondPager - Gets the list of skus for the given resource type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • resourceType - The resource type.
  • nestedResourceTypeFirst - The first child resource type.
  • nestedResourceTypeSecond - The second child resource type.
  • options - SKUsClientListByResourceTypeRegistrationsNestedResourceTypeSecondOptions contains the optional parameters for the SKUsClient.NewListByResourceTypeRegistrationsNestedResourceTypeSecondPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeSecond.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSKUsClient().NewListByResourceTypeRegistrationsNestedResourceTypeSecondPager("Microsoft.Contoso", "testResourceType", "nestedResourceTypeFirst", "nestedResourceTypeSecond", 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.SKUResourceArrayResponseWithContinuation = armproviderhub.SKUResourceArrayResponseWithContinuation{
		// 	Value: []*armproviderhub.SKUResource{
		// 		{
		// 			Name: to.Ptr("testSku"),
		// 			Properties: &armproviderhub.SKUResourceProperties{
		// 				SKUSettings: []*armproviderhub.SKUSetting{
		// 					{
		// 						Name: to.Ptr("freeSku"),
		// 						Kind: to.Ptr("Standard"),
		// 						Tier: to.Ptr("Tier1"),
		// 					},
		// 					{
		// 						Name: to.Ptr("premiumSku"),
		// 						Costs: []*armproviderhub.SKUCost{
		// 							{
		// 								MeterID: to.Ptr("xxx"),
		// 						}},
		// 						Kind: to.Ptr("Premium"),
		// 						Tier: to.Ptr("Tier2"),
		// 				}},
		// 			},
		// 	}},
		// }
	}
}
Output:

func (*SKUsClient) NewListByResourceTypeRegistrationsNestedResourceTypeThirdPager added in v0.4.0

func (client *SKUsClient) NewListByResourceTypeRegistrationsNestedResourceTypeThirdPager(providerNamespace string, resourceType string, nestedResourceTypeFirst string, nestedResourceTypeSecond string, nestedResourceTypeThird string, options *SKUsClientListByResourceTypeRegistrationsNestedResourceTypeThirdOptions) *runtime.Pager[SKUsClientListByResourceTypeRegistrationsNestedResourceTypeThirdResponse]

NewListByResourceTypeRegistrationsNestedResourceTypeThirdPager - Gets the list of skus for the given resource type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • resourceType - The resource type.
  • nestedResourceTypeFirst - The first child resource type.
  • nestedResourceTypeSecond - The second child resource type.
  • nestedResourceTypeThird - The third child resource type.
  • options - SKUsClientListByResourceTypeRegistrationsNestedResourceTypeThirdOptions contains the optional parameters for the SKUsClient.NewListByResourceTypeRegistrationsNestedResourceTypeThirdPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeThird.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSKUsClient().NewListByResourceTypeRegistrationsNestedResourceTypeThirdPager("Microsoft.Contoso", "testResourceType", "nestedResourceTypeFirst", "nestedResourceTypeSecond", "nestedResourceTypeThird", 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.SKUResourceArrayResponseWithContinuation = armproviderhub.SKUResourceArrayResponseWithContinuation{
		// 	Value: []*armproviderhub.SKUResource{
		// 		{
		// 			Name: to.Ptr("testSku"),
		// 			Properties: &armproviderhub.SKUResourceProperties{
		// 				SKUSettings: []*armproviderhub.SKUSetting{
		// 					{
		// 						Name: to.Ptr("freeSku"),
		// 						Kind: to.Ptr("Standard"),
		// 						Tier: to.Ptr("Tier1"),
		// 					},
		// 					{
		// 						Name: to.Ptr("premiumSku"),
		// 						Costs: []*armproviderhub.SKUCost{
		// 							{
		// 								MeterID: to.Ptr("xxx"),
		// 						}},
		// 						Kind: to.Ptr("Premium"),
		// 						Tier: to.Ptr("Tier2"),
		// 				}},
		// 			},
		// 	}},
		// }
	}
}
Output:

func (*SKUsClient) NewListByResourceTypeRegistrationsPager added in v0.4.0

func (client *SKUsClient) NewListByResourceTypeRegistrationsPager(providerNamespace string, resourceType string, options *SKUsClientListByResourceTypeRegistrationsOptions) *runtime.Pager[SKUsClientListByResourceTypeRegistrationsResponse]

NewListByResourceTypeRegistrationsPager - Gets the list of skus for the given resource type.

Generated from API version 2020-11-20

  • providerNamespace - The name of the resource provider hosted within ProviderHub.
  • resourceType - The resource type.
  • options - SKUsClientListByResourceTypeRegistrationsOptions contains the optional parameters for the SKUsClient.NewListByResourceTypeRegistrationsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Skus_ListByResourceTypeRegistrations.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/providerhub/armproviderhub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armproviderhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSKUsClient().NewListByResourceTypeRegistrationsPager("Microsoft.Contoso", "testResourceType", 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.SKUResourceArrayResponseWithContinuation = armproviderhub.SKUResourceArrayResponseWithContinuation{
		// 	Value: []*armproviderhub.SKUResource{
		// 		{
		// 			Name: to.Ptr("testSku"),
		// 			Properties: &armproviderhub.SKUResourceProperties{
		// 				SKUSettings: []*armproviderhub.SKUSetting{
		// 					{
		// 						Name: to.Ptr("freeSku"),
		// 						Kind: to.Ptr("Standard"),
		// 						Tier: to.Ptr("Tier1"),
		// 					},
		// 					{
		// 						Name: to.Ptr("premiumSku"),
		// 						Costs: []*armproviderhub.SKUCost{
		// 							{
		// 								MeterID: to.Ptr("xxx"),
		// 						}},
		// 						Kind: to.Ptr("Premium"),
		// 						Tier: to.Ptr("Tier2"),
		// 				}},
		// 			},
		// 	}},
		// }
	}
}
Output:

type SKUsClientCreateOrUpdateNestedResourceTypeFirstOptions added in v0.2.0

type SKUsClientCreateOrUpdateNestedResourceTypeFirstOptions struct {
}

SKUsClientCreateOrUpdateNestedResourceTypeFirstOptions contains the optional parameters for the SKUsClient.CreateOrUpdateNestedResourceTypeFirst method.

type SKUsClientCreateOrUpdateNestedResourceTypeFirstResponse added in v0.2.0

type SKUsClientCreateOrUpdateNestedResourceTypeFirstResponse struct {
	SKUResource
}

SKUsClientCreateOrUpdateNestedResourceTypeFirstResponse contains the response from method SKUsClient.CreateOrUpdateNestedResourceTypeFirst.

type SKUsClientCreateOrUpdateNestedResourceTypeSecondOptions added in v0.2.0

type SKUsClientCreateOrUpdateNestedResourceTypeSecondOptions struct {
}

SKUsClientCreateOrUpdateNestedResourceTypeSecondOptions contains the optional parameters for the SKUsClient.CreateOrUpdateNestedResourceTypeSecond method.

type SKUsClientCreateOrUpdateNestedResourceTypeSecondResponse added in v0.2.0

type SKUsClientCreateOrUpdateNestedResourceTypeSecondResponse struct {
	SKUResource
}

SKUsClientCreateOrUpdateNestedResourceTypeSecondResponse contains the response from method SKUsClient.CreateOrUpdateNestedResourceTypeSecond.

type SKUsClientCreateOrUpdateNestedResourceTypeThirdOptions added in v0.2.0

type SKUsClientCreateOrUpdateNestedResourceTypeThirdOptions struct {
}

SKUsClientCreateOrUpdateNestedResourceTypeThirdOptions contains the optional parameters for the SKUsClient.CreateOrUpdateNestedResourceTypeThird method.

type SKUsClientCreateOrUpdateNestedResourceTypeThirdResponse added in v0.2.0

type SKUsClientCreateOrUpdateNestedResourceTypeThirdResponse struct {
	SKUResource
}

SKUsClientCreateOrUpdateNestedResourceTypeThirdResponse contains the response from method SKUsClient.CreateOrUpdateNestedResourceTypeThird.

type SKUsClientCreateOrUpdateOptions added in v0.2.0

type SKUsClientCreateOrUpdateOptions struct {
}

SKUsClientCreateOrUpdateOptions contains the optional parameters for the SKUsClient.CreateOrUpdate method.

type SKUsClientCreateOrUpdateResponse added in v0.2.0

type SKUsClientCreateOrUpdateResponse struct {
	SKUResource
}

SKUsClientCreateOrUpdateResponse contains the response from method SKUsClient.CreateOrUpdate.

type SKUsClientDeleteNestedResourceTypeFirstOptions added in v0.2.0

type SKUsClientDeleteNestedResourceTypeFirstOptions struct {
}

SKUsClientDeleteNestedResourceTypeFirstOptions contains the optional parameters for the SKUsClient.DeleteNestedResourceTypeFirst method.

type SKUsClientDeleteNestedResourceTypeFirstResponse added in v0.2.0

type SKUsClientDeleteNestedResourceTypeFirstResponse struct {
}

SKUsClientDeleteNestedResourceTypeFirstResponse contains the response from method SKUsClient.DeleteNestedResourceTypeFirst.

type SKUsClientDeleteNestedResourceTypeSecondOptions added in v0.2.0

type SKUsClientDeleteNestedResourceTypeSecondOptions struct {
}

SKUsClientDeleteNestedResourceTypeSecondOptions contains the optional parameters for the SKUsClient.DeleteNestedResourceTypeSecond method.

type SKUsClientDeleteNestedResourceTypeSecondResponse added in v0.2.0

type SKUsClientDeleteNestedResourceTypeSecondResponse struct {
}

SKUsClientDeleteNestedResourceTypeSecondResponse contains the response from method SKUsClient.DeleteNestedResourceTypeSecond.

type SKUsClientDeleteNestedResourceTypeThirdOptions added in v0.2.0

type SKUsClientDeleteNestedResourceTypeThirdOptions struct {
}

SKUsClientDeleteNestedResourceTypeThirdOptions contains the optional parameters for the SKUsClient.DeleteNestedResourceTypeThird method.

type SKUsClientDeleteNestedResourceTypeThirdResponse added in v0.2.0

type SKUsClientDeleteNestedResourceTypeThirdResponse struct {
}

SKUsClientDeleteNestedResourceTypeThirdResponse contains the response from method SKUsClient.DeleteNestedResourceTypeThird.

type SKUsClientDeleteOptions added in v0.2.0

type SKUsClientDeleteOptions struct {
}

SKUsClientDeleteOptions contains the optional parameters for the SKUsClient.Delete method.

type SKUsClientDeleteResponse added in v0.2.0

type SKUsClientDeleteResponse struct {
}

SKUsClientDeleteResponse contains the response from method SKUsClient.Delete.

type SKUsClientGetNestedResourceTypeFirstOptions added in v0.2.0

type SKUsClientGetNestedResourceTypeFirstOptions struct {
}

SKUsClientGetNestedResourceTypeFirstOptions contains the optional parameters for the SKUsClient.GetNestedResourceTypeFirst method.

type SKUsClientGetNestedResourceTypeFirstResponse added in v0.2.0

type SKUsClientGetNestedResourceTypeFirstResponse struct {
	SKUResource
}

SKUsClientGetNestedResourceTypeFirstResponse contains the response from method SKUsClient.GetNestedResourceTypeFirst.

type SKUsClientGetNestedResourceTypeSecondOptions added in v0.2.0

type SKUsClientGetNestedResourceTypeSecondOptions struct {
}

SKUsClientGetNestedResourceTypeSecondOptions contains the optional parameters for the SKUsClient.GetNestedResourceTypeSecond method.

type SKUsClientGetNestedResourceTypeSecondResponse added in v0.2.0

type SKUsClientGetNestedResourceTypeSecondResponse struct {
	SKUResource
}

SKUsClientGetNestedResourceTypeSecondResponse contains the response from method SKUsClient.GetNestedResourceTypeSecond.

type SKUsClientGetNestedResourceTypeThirdOptions added in v0.2.0

type SKUsClientGetNestedResourceTypeThirdOptions struct {
}

SKUsClientGetNestedResourceTypeThirdOptions contains the optional parameters for the SKUsClient.GetNestedResourceTypeThird method.

type SKUsClientGetNestedResourceTypeThirdResponse added in v0.2.0

type SKUsClientGetNestedResourceTypeThirdResponse struct {
	SKUResource
}

SKUsClientGetNestedResourceTypeThirdResponse contains the response from method SKUsClient.GetNestedResourceTypeThird.

type SKUsClientGetOptions added in v0.2.0

type SKUsClientGetOptions struct {
}

SKUsClientGetOptions contains the optional parameters for the SKUsClient.Get method.

type SKUsClientGetResponse added in v0.2.0

type SKUsClientGetResponse struct {
	SKUResource
}

SKUsClientGetResponse contains the response from method SKUsClient.Get.

type SKUsClientListByResourceTypeRegistrationsNestedResourceTypeFirstOptions added in v0.2.0

type SKUsClientListByResourceTypeRegistrationsNestedResourceTypeFirstOptions struct {
}

SKUsClientListByResourceTypeRegistrationsNestedResourceTypeFirstOptions contains the optional parameters for the SKUsClient.NewListByResourceTypeRegistrationsNestedResourceTypeFirstPager method.

type SKUsClientListByResourceTypeRegistrationsNestedResourceTypeFirstResponse added in v0.2.0

type SKUsClientListByResourceTypeRegistrationsNestedResourceTypeFirstResponse struct {
	SKUResourceArrayResponseWithContinuation
}

SKUsClientListByResourceTypeRegistrationsNestedResourceTypeFirstResponse contains the response from method SKUsClient.NewListByResourceTypeRegistrationsNestedResourceTypeFirstPager.

type SKUsClientListByResourceTypeRegistrationsNestedResourceTypeSecondOptions added in v0.2.0

type SKUsClientListByResourceTypeRegistrationsNestedResourceTypeSecondOptions struct {
}

SKUsClientListByResourceTypeRegistrationsNestedResourceTypeSecondOptions contains the optional parameters for the SKUsClient.NewListByResourceTypeRegistrationsNestedResourceTypeSecondPager method.

type SKUsClientListByResourceTypeRegistrationsNestedResourceTypeSecondResponse added in v0.2.0

type SKUsClientListByResourceTypeRegistrationsNestedResourceTypeSecondResponse struct {
	SKUResourceArrayResponseWithContinuation
}

SKUsClientListByResourceTypeRegistrationsNestedResourceTypeSecondResponse contains the response from method SKUsClient.NewListByResourceTypeRegistrationsNestedResourceTypeSecondPager.

type SKUsClientListByResourceTypeRegistrationsNestedResourceTypeThirdOptions added in v0.2.0

type SKUsClientListByResourceTypeRegistrationsNestedResourceTypeThirdOptions struct {
}

SKUsClientListByResourceTypeRegistrationsNestedResourceTypeThirdOptions contains the optional parameters for the SKUsClient.NewListByResourceTypeRegistrationsNestedResourceTypeThirdPager method.

type SKUsClientListByResourceTypeRegistrationsNestedResourceTypeThirdResponse added in v0.2.0

type SKUsClientListByResourceTypeRegistrationsNestedResourceTypeThirdResponse struct {
	SKUResourceArrayResponseWithContinuation
}

SKUsClientListByResourceTypeRegistrationsNestedResourceTypeThirdResponse contains the response from method SKUsClient.NewListByResourceTypeRegistrationsNestedResourceTypeThirdPager.

type SKUsClientListByResourceTypeRegistrationsOptions added in v0.2.0

type SKUsClientListByResourceTypeRegistrationsOptions struct {
}

SKUsClientListByResourceTypeRegistrationsOptions contains the optional parameters for the SKUsClient.NewListByResourceTypeRegistrationsPager method.

type SKUsClientListByResourceTypeRegistrationsResponse added in v0.2.0

type SKUsClientListByResourceTypeRegistrationsResponse struct {
	SKUResourceArrayResponseWithContinuation
}

SKUsClientListByResourceTypeRegistrationsResponse contains the response from method SKUsClient.NewListByResourceTypeRegistrationsPager.

type ServiceTreeInfo

type ServiceTreeInfo struct {
	ComponentID *string
	ServiceID   *string
}

func (ServiceTreeInfo) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type ServiceTreeInfo.

func (*ServiceTreeInfo) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceTreeInfo.

type SubscriptionLifecycleNotificationSpecifications

type SubscriptionLifecycleNotificationSpecifications struct {
	SoftDeleteTTL                    *string
	SubscriptionStateOverrideActions []*SubscriptionStateOverrideAction
}

func (SubscriptionLifecycleNotificationSpecifications) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type SubscriptionLifecycleNotificationSpecifications.

func (*SubscriptionLifecycleNotificationSpecifications) UnmarshalJSON added in v1.1.0

UnmarshalJSON implements the json.Unmarshaller interface for type SubscriptionLifecycleNotificationSpecifications.

type SubscriptionNotificationOperation

type SubscriptionNotificationOperation string
const (
	SubscriptionNotificationOperationBillingCancellation    SubscriptionNotificationOperation = "BillingCancellation"
	SubscriptionNotificationOperationDeleteAllResources     SubscriptionNotificationOperation = "DeleteAllResources"
	SubscriptionNotificationOperationNoOp                   SubscriptionNotificationOperation = "NoOp"
	SubscriptionNotificationOperationNotDefined             SubscriptionNotificationOperation = "NotDefined"
	SubscriptionNotificationOperationSoftDeleteAllResources SubscriptionNotificationOperation = "SoftDeleteAllResources"
	SubscriptionNotificationOperationUndoSoftDelete         SubscriptionNotificationOperation = "UndoSoftDelete"
)

func PossibleSubscriptionNotificationOperationValues

func PossibleSubscriptionNotificationOperationValues() []SubscriptionNotificationOperation

PossibleSubscriptionNotificationOperationValues returns the possible values for the SubscriptionNotificationOperation const type.

type SubscriptionReregistrationResult

type SubscriptionReregistrationResult string
const (
	SubscriptionReregistrationResultConditionalUpdate SubscriptionReregistrationResult = "ConditionalUpdate"
	SubscriptionReregistrationResultFailed            SubscriptionReregistrationResult = "Failed"
	SubscriptionReregistrationResultForcedUpdate      SubscriptionReregistrationResult = "ForcedUpdate"
	SubscriptionReregistrationResultNotApplicable     SubscriptionReregistrationResult = "NotApplicable"
)

func PossibleSubscriptionReregistrationResultValues

func PossibleSubscriptionReregistrationResultValues() []SubscriptionReregistrationResult

PossibleSubscriptionReregistrationResultValues returns the possible values for the SubscriptionReregistrationResult const type.

type SubscriptionState

type SubscriptionState string
const (
	SubscriptionStateDeleted    SubscriptionState = "Deleted"
	SubscriptionStateDisabled   SubscriptionState = "Disabled"
	SubscriptionStateEnabled    SubscriptionState = "Enabled"
	SubscriptionStateNotDefined SubscriptionState = "NotDefined"
	SubscriptionStatePastDue    SubscriptionState = "PastDue"
	SubscriptionStateWarned     SubscriptionState = "Warned"
)

func PossibleSubscriptionStateValues

func PossibleSubscriptionStateValues() []SubscriptionState

PossibleSubscriptionStateValues returns the possible values for the SubscriptionState const type.

type SubscriptionStateOverrideAction

type SubscriptionStateOverrideAction struct {
	// REQUIRED
	Action *SubscriptionNotificationOperation

	// REQUIRED
	State *SubscriptionTransitioningState
}

func (SubscriptionStateOverrideAction) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type SubscriptionStateOverrideAction.

func (*SubscriptionStateOverrideAction) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type SubscriptionStateOverrideAction.

type SubscriptionStateRule

type SubscriptionStateRule struct {
	AllowedActions []*string
	State          *SubscriptionState
}

func (SubscriptionStateRule) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SubscriptionStateRule.

func (*SubscriptionStateRule) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type SubscriptionStateRule.

type SubscriptionTransitioningState

type SubscriptionTransitioningState string
const (
	SubscriptionTransitioningStateDeleted                 SubscriptionTransitioningState = "Deleted"
	SubscriptionTransitioningStateRegistered              SubscriptionTransitioningState = "Registered"
	SubscriptionTransitioningStateSuspended               SubscriptionTransitioningState = "Suspended"
	SubscriptionTransitioningStateSuspendedToDeleted      SubscriptionTransitioningState = "SuspendedToDeleted"
	SubscriptionTransitioningStateSuspendedToRegistered   SubscriptionTransitioningState = "SuspendedToRegistered"
	SubscriptionTransitioningStateSuspendedToUnregistered SubscriptionTransitioningState = "SuspendedToUnregistered"
	SubscriptionTransitioningStateSuspendedToWarned       SubscriptionTransitioningState = "SuspendedToWarned"
	SubscriptionTransitioningStateUnregistered            SubscriptionTransitioningState = "Unregistered"
	SubscriptionTransitioningStateWarned                  SubscriptionTransitioningState = "Warned"
	SubscriptionTransitioningStateWarnedToDeleted         SubscriptionTransitioningState = "WarnedToDeleted"
	SubscriptionTransitioningStateWarnedToRegistered      SubscriptionTransitioningState = "WarnedToRegistered"
	SubscriptionTransitioningStateWarnedToSuspended       SubscriptionTransitioningState = "WarnedToSuspended"
	SubscriptionTransitioningStateWarnedToUnregistered    SubscriptionTransitioningState = "WarnedToUnregistered"
)

func PossibleSubscriptionTransitioningStateValues

func PossibleSubscriptionTransitioningStateValues() []SubscriptionTransitioningState

PossibleSubscriptionTransitioningStateValues returns the possible values for the SubscriptionTransitioningState const type.

type SwaggerSpecification

type SwaggerSpecification struct {
	APIVersions          []*string
	SwaggerSpecFolderURI *string
}

func (SwaggerSpecification) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SwaggerSpecification.

func (*SwaggerSpecification) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type SwaggerSpecification.

type TemplateDeploymentCapabilities

type TemplateDeploymentCapabilities string
const (
	TemplateDeploymentCapabilitiesDefault   TemplateDeploymentCapabilities = "Default"
	TemplateDeploymentCapabilitiesPreflight TemplateDeploymentCapabilities = "Preflight"
)

func PossibleTemplateDeploymentCapabilitiesValues

func PossibleTemplateDeploymentCapabilitiesValues() []TemplateDeploymentCapabilities

PossibleTemplateDeploymentCapabilitiesValues returns the possible values for the TemplateDeploymentCapabilities const type.

type TemplateDeploymentOptions

type TemplateDeploymentOptions struct {
	PreflightOptions   []*PreflightOption
	PreflightSupported *bool
}

func (TemplateDeploymentOptions) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type TemplateDeploymentOptions.

func (*TemplateDeploymentOptions) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type TemplateDeploymentOptions.

type TemplateDeploymentPolicy

type TemplateDeploymentPolicy struct {
	// REQUIRED
	Capabilities *TemplateDeploymentCapabilities

	// REQUIRED
	PreflightOptions *TemplateDeploymentPreflightOptions
}

func (TemplateDeploymentPolicy) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type TemplateDeploymentPolicy.

func (*TemplateDeploymentPolicy) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type TemplateDeploymentPolicy.

type TemplateDeploymentPreflightOptions

type TemplateDeploymentPreflightOptions string
const (
	TemplateDeploymentPreflightOptionsDeploymentRequests TemplateDeploymentPreflightOptions = "DeploymentRequests"
	TemplateDeploymentPreflightOptionsNone               TemplateDeploymentPreflightOptions = "None"
	TemplateDeploymentPreflightOptionsRegisteredOnly     TemplateDeploymentPreflightOptions = "RegisteredOnly"
	TemplateDeploymentPreflightOptionsTestOnly           TemplateDeploymentPreflightOptions = "TestOnly"
	TemplateDeploymentPreflightOptionsValidationRequests TemplateDeploymentPreflightOptions = "ValidationRequests"
)

func PossibleTemplateDeploymentPreflightOptionsValues

func PossibleTemplateDeploymentPreflightOptionsValues() []TemplateDeploymentPreflightOptions

PossibleTemplateDeploymentPreflightOptionsValues returns the possible values for the TemplateDeploymentPreflightOptions const type.

type ThirdPartyProviderAuthorization

type ThirdPartyProviderAuthorization struct {
	Authorizations    []*LightHouseAuthorization
	ManagedByTenantID *string
}

func (ThirdPartyProviderAuthorization) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ThirdPartyProviderAuthorization.

func (*ThirdPartyProviderAuthorization) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type ThirdPartyProviderAuthorization.

type ThrottlingMetric

type ThrottlingMetric struct {
	// REQUIRED
	Limit *int64

	// REQUIRED
	Type     *ThrottlingMetricType
	Interval *string
}

func (ThrottlingMetric) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type ThrottlingMetric.

func (*ThrottlingMetric) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type ThrottlingMetric.

type ThrottlingMetricType

type ThrottlingMetricType string
const (
	ThrottlingMetricTypeNotSpecified      ThrottlingMetricType = "NotSpecified"
	ThrottlingMetricTypeNumberOfRequests  ThrottlingMetricType = "NumberOfRequests"
	ThrottlingMetricTypeNumberOfResources ThrottlingMetricType = "NumberOfResources"
)

func PossibleThrottlingMetricTypeValues

func PossibleThrottlingMetricTypeValues() []ThrottlingMetricType

PossibleThrottlingMetricTypeValues returns the possible values for the ThrottlingMetricType const type.

type ThrottlingRule

type ThrottlingRule struct {
	// REQUIRED
	Action *string

	// REQUIRED
	Metrics          []*ThrottlingMetric
	RequiredFeatures []*string
}

func (ThrottlingRule) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ThrottlingRule.

func (*ThrottlingRule) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type ThrottlingRule.

type TrafficRegionCategory

type TrafficRegionCategory string
const (
	TrafficRegionCategoryCanary                 TrafficRegionCategory = "Canary"
	TrafficRegionCategoryHighTraffic            TrafficRegionCategory = "HighTraffic"
	TrafficRegionCategoryLowTraffic             TrafficRegionCategory = "LowTraffic"
	TrafficRegionCategoryMediumTraffic          TrafficRegionCategory = "MediumTraffic"
	TrafficRegionCategoryNone                   TrafficRegionCategory = "None"
	TrafficRegionCategoryNotSpecified           TrafficRegionCategory = "NotSpecified"
	TrafficRegionCategoryRestOfTheWorldGroupOne TrafficRegionCategory = "RestOfTheWorldGroupOne"
	TrafficRegionCategoryRestOfTheWorldGroupTwo TrafficRegionCategory = "RestOfTheWorldGroupTwo"
)

func PossibleTrafficRegionCategoryValues

func PossibleTrafficRegionCategoryValues() []TrafficRegionCategory

PossibleTrafficRegionCategoryValues returns the possible values for the TrafficRegionCategory const type.

type TrafficRegionRolloutConfiguration

type TrafficRegionRolloutConfiguration struct {
	Regions      []*string
	WaitDuration *string
}

func (TrafficRegionRolloutConfiguration) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type TrafficRegionRolloutConfiguration.

func (*TrafficRegionRolloutConfiguration) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type TrafficRegionRolloutConfiguration.

type TrafficRegions

type TrafficRegions struct {
	Regions []*string
}

func (TrafficRegions) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type TrafficRegions.

func (*TrafficRegions) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type TrafficRegions.

type TypedErrorInfo

type TypedErrorInfo struct {
	// REQUIRED
	Type *string

	// READ-ONLY; Anything
	Info any
}

func (TypedErrorInfo) MarshalJSON added in v1.1.0

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

MarshalJSON implements the json.Marshaller interface for type TypedErrorInfo.

func (*TypedErrorInfo) UnmarshalJSON added in v1.1.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type TypedErrorInfo.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL