armsaas

package module
v0.7.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: 12 Imported by: 5

README

Azure SaaS Module for Go

PkgGoDev

The armsaas module provides operations for working with Azure SaaS.

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 SaaS module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/saas/armsaas

Authorization

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

type AccessTokenResult struct {
	// The Publisher Offer Base Uri
	PublisherOfferBaseURI *string

	// The generated token
	Token *string
}

AccessTokenResult - the ISV access token result response.

func (AccessTokenResult) MarshalJSON added in v0.6.0

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

MarshalJSON implements the json.Marshaller interface for type AccessTokenResult.

func (*AccessTokenResult) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type AccessTokenResult.

type App added in v0.2.0

type App struct {
	// the resource location.
	Location *string

	// the resource name.
	Name *string

	// the resource properties.
	Properties *AppProperties

	// the resource tags.
	Tags map[string]*string

	// the resource type.
	Type *string

	// READ-ONLY; the resource Id.
	ID *string
}

App - the saasApp resource.

func (App) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type App.

func (*App) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type App.

type AppOperation added in v0.2.0

type AppOperation struct {
	// the operation display
	Display *AppOperationDisplay

	// whether the operation is a data action or not.
	IsDataAction *bool

	// the operation name
	Name *string

	// the operation origin
	Origin *string
}

AppOperation - saas app operations

func (AppOperation) MarshalJSON added in v0.6.0

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

MarshalJSON implements the json.Marshaller interface for type AppOperation.

func (*AppOperation) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type AppOperation.

type AppOperationDisplay added in v0.2.0

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

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

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

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

AppOperationDisplay - Saas app operation display

func (AppOperationDisplay) MarshalJSON added in v0.6.0

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

MarshalJSON implements the json.Marshaller interface for type AppOperationDisplay.

func (*AppOperationDisplay) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type AppOperationDisplay.

type AppOperationsResponseWithContinuation added in v0.2.0

type AppOperationsResponseWithContinuation struct {
	// the next link to query to get the remaining results.
	NextLink *string

	// the value of response.
	Value []*AppOperation
}

AppOperationsResponseWithContinuation - saas app operation response with continuation.

func (AppOperationsResponseWithContinuation) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type AppOperationsResponseWithContinuation.

func (*AppOperationsResponseWithContinuation) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type AppOperationsResponseWithContinuation.

type AppPlan added in v0.2.0

type AppPlan struct {
	// the plan id.
	Name *string

	// the offer id.
	Product *string

	// the publisher id.
	Publisher *string
}

AppPlan - Saas resource plan.

func (AppPlan) MarshalJSON added in v0.6.0

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

MarshalJSON implements the json.Marshaller interface for type AppPlan.

func (*AppPlan) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type AppPlan.

type AppProperties added in v0.2.0

type AppProperties struct {
	// the resource plan details.
	SaasAppPlan *AppPlan

	// the Saas resource status.
	Status *SaasAppStatus
}

AppProperties - Saas resource properties.

func (AppProperties) MarshalJSON added in v0.6.0

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

MarshalJSON implements the json.Marshaller interface for type AppProperties.

func (*AppProperties) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type AppProperties.

type AppResponseWithContinuation added in v0.2.0

type AppResponseWithContinuation struct {
	// the next link to query to get the remaining results.
	NextLink *string

	// the value of response.
	Value []*App
}

AppResponseWithContinuation - saas app response with continuation.

func (AppResponseWithContinuation) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type AppResponseWithContinuation.

func (*AppResponseWithContinuation) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type AppResponseWithContinuation.

type ApplicationsClient

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

ApplicationsClient contains the methods for the Applications group. Don't use this type directly, use NewApplicationsClient() instead.

func NewApplicationsClient

func NewApplicationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ApplicationsClient, error)

NewApplicationsClient creates a new instance of ApplicationsClient with the specified values.

  • subscriptionID - The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ApplicationsClient) NewListPager added in v0.4.0

func (client *ApplicationsClient) NewListPager(resourceGroupName string, options *ApplicationsClientListOptions) *runtime.Pager[ApplicationsClientListResponse]

NewListPager - Gets all SaaS resources by subscription id and resource group name.

Generated from API version 2018-03-01-beta

  • resourceGroupName - The name of the resource group.
  • options - ApplicationsClientListOptions contains the optional parameters for the ApplicationsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/saas/resource-manager/Microsoft.SaaS/preview/2018-03-01-beta/examples/saasV1/SaaSGetApplications.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/saas/armsaas"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsaas.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewApplicationsClient().NewListPager("myResourceGroup", 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.AppResponseWithContinuation = armsaas.AppResponseWithContinuation{
		// 	Value: []*armsaas.App{
		// 		{
		// 			Name: to.Ptr("myapp"),
		// 			Type: to.Ptr("Microsoft.SaaS/applications"),
		// 			ID: to.Ptr("/subscriptions/bc6c2f82-a39d-41b8-a648-71527498a23e/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/applications/myapp"),
		// 			Location: to.Ptr("location"),
		// 			Properties: &armsaas.AppProperties{
		// 				SaasAppPlan: &armsaas.AppPlan{
		// 					Name: to.Ptr("myPlan1"),
		// 					Product: to.Ptr("myOffer"),
		// 					Publisher: to.Ptr("contoso"),
		// 				},
		// 				Status: to.Ptr(armsaas.SaasAppStatusSubscribed),
		// 			},
		// 			Tags: map[string]*string{
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("myapp"),
		// 			Type: to.Ptr("Microsoft.SaaS/applications"),
		// 			ID: to.Ptr("/subscriptions/bc6c2f82-a39d-41b8-a648-71527498a23e/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/applications/myapp"),
		// 			Location: to.Ptr("location"),
		// 			Properties: &armsaas.AppProperties{
		// 				SaasAppPlan: &armsaas.AppPlan{
		// 					Name: to.Ptr("myPlan2"),
		// 					Product: to.Ptr("myOffer"),
		// 					Publisher: to.Ptr("contoso"),
		// 				},
		// 				Status: to.Ptr(armsaas.SaasAppStatusSubscribed),
		// 			},
		// 			Tags: map[string]*string{
		// 			},
		// 	}},
		// }
	}
}
Output:

type ApplicationsClientListOptions added in v0.2.0

type ApplicationsClientListOptions struct {
}

ApplicationsClientListOptions contains the optional parameters for the ApplicationsClient.NewListPager method.

type ApplicationsClientListResponse added in v0.2.0

type ApplicationsClientListResponse struct {
	// saas app response with continuation.
	AppResponseWithContinuation
}

ApplicationsClientListResponse contains the response from method ApplicationsClient.NewListPager.

type Client added in v0.2.0

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

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

func NewClient added in v0.2.0

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

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

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

func (*Client) BeginCreateResource added in v0.2.0

func (client *Client) BeginCreateResource(ctx context.Context, parameters ResourceCreation, options *ClientBeginCreateResourceOptions) (*runtime.Poller[ClientCreateResourceResponse], error)

BeginCreateResource - Creates a SaaS resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-01-beta

  • parameters - Parameters supplied to the create saas operation.
  • options - ClientBeginCreateResourceOptions contains the optional parameters for the Client.BeginCreateResource method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/saas/resource-manager/Microsoft.SaaS/preview/2018-03-01-beta/examples/saasV2/SaasPut.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/saas/armsaas"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsaas.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewClient().BeginCreateResource(ctx, armsaas.ResourceCreation{
		Properties: &armsaas.CreationProperties{
			OfferID: to.Ptr("microsofthealthcarebot"),
			PaymentChannelMetadata: map[string]*string{
				"AzureSubscriptionId": to.Ptr("155af98a-3205-47e7-883b-a2ab9db9f88d"),
			},
			PaymentChannelType: to.Ptr(armsaas.PaymentChannelTypeSubscriptionDelegated),
			PublisherID:        to.Ptr("microsoft-hcb"),
			SaasResourceName:   to.Ptr("testRunnerFromArm"),
			SKUID:              to.Ptr("free"),
			TermID:             to.Ptr("hjdtn7tfnxcy"),
		},
	}, 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.Resource = armsaas.Resource{
	// 	Name: to.Ptr("diyakobo-transfer"),
	// 	Type: to.Ptr("Microsoft.SaaS/saasresources"),
	// 	ID: to.Ptr("/providers/Microsoft.SaaS/saasresources/115c3523-1fae-757f-af86-7b27cfd29805"),
	// 	Properties: &armsaas.ResourceProperties{
	// 		OfferID: to.Ptr("microsofthealthcarebot"),
	// 		PaymentChannelMetadata: map[string]*string{
	// 			"azureSubscriptionId": to.Ptr("155af98a-3205-47e7-883b-a2ab9db9f88d"),
	// 			"resourceId": to.Ptr("b25dba9a-1bd7-4600-9447-3d27d11a6477"),
	// 		},
	// 		PublisherID: to.Ptr("microsoft-hcb"),
	// 		SaasResourceName: to.Ptr("diyakobo-transfer"),
	// 		SKUID: to.Ptr("free"),
	// 		Created: to.Ptr("2020-10-12T05:08:40.9235607Z"),
	// 		IsFreeTrial: to.Ptr(false),
	// 		LastModified: to.Ptr("2020-11-12T21:25:40.2736665Z"),
	// 		Status: to.Ptr(armsaas.SaasResourceStatusSubscribed),
	// 		Term: &armsaas.PropertiesTerm{
	// 			EndDate: to.Ptr("2020-12-11T00:00:00Z"),
	// 			StartDate: to.Ptr("2020-11-12T00:00:00Z"),
	// 			TermUnit: to.Ptr("P1M"),
	// 		},
	// 	},
	// 	Tags: map[string]*string{
	// 	},
	// }
}
Output:

func (*Client) BeginDelete added in v0.2.0

func (client *Client) BeginDelete(ctx context.Context, resourceID string, parameters DeleteOptions, options *ClientBeginDeleteOptions) (*runtime.Poller[ClientDeleteResponse], error)

BeginDelete - Deletes the specified SaaS. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-01-beta

  • resourceID - The Saas resource ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
  • parameters - Parameters supplied to delete saas operation.
  • options - ClientBeginDeleteOptions contains the optional parameters for the Client.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/saas/resource-manager/Microsoft.SaaS/preview/2018-03-01-beta/examples/saasV2/SaasDelete.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/saas/armsaas"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsaas.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewClient().BeginDelete(ctx, "115c3523-1fae-757f-af86-7b27cfd29805", armsaas.DeleteOptions{
		ReasonCode:      to.Ptr[float32](0),
		UnsubscribeOnly: to.Ptr(true),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*Client) BeginUpdateResource added in v0.2.0

func (client *Client) BeginUpdateResource(ctx context.Context, resourceID string, parameters ResourceCreation, options *ClientBeginUpdateResourceOptions) (*runtime.Poller[ClientUpdateResourceResponse], error)

BeginUpdateResource - Updates a SaaS resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-01-beta

  • resourceID - The Saas resource ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
  • parameters - Parameters supplied to the update saas operation.
  • options - ClientBeginUpdateResourceOptions contains the optional parameters for the Client.BeginUpdateResource method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/saas/resource-manager/Microsoft.SaaS/preview/2018-03-01-beta/examples/saasV2/SaasPatch.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/saas/armsaas"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsaas.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewClient().BeginUpdateResource(ctx, "115c3523-1fae-757f-af86-7b27cfd29805", armsaas.ResourceCreation{
		Properties: &armsaas.CreationProperties{
			SKUID: to.Ptr("premium"),
		},
		Tags: map[string]*string{},
	}, 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.Resource = armsaas.Resource{
	// 	Name: to.Ptr("MyContosoSubscription"),
	// 	Type: to.Ptr("Microsoft.SaaS/saasresources"),
	// 	ID: to.Ptr("/providers/Microsoft.SaaS/saasresources/115c3523-1fae-757f-af86-7b27cfd29805"),
	// 	Properties: &armsaas.ResourceProperties{
	// 		AutoRenew: to.Ptr(true),
	// 		OfferID: to.Ptr("contosoOffer"),
	// 		PaymentChannelMetadata: map[string]*string{
	// 			"azureSubscriptionId": to.Ptr("c825645b-e31b-9cf4-1cee-2aba9e58bc7c"),
	// 			"resourceId": to.Ptr("263ebe8c-3621-4ac0-a6ba-f1419bfb9166"),
	// 		},
	// 		PaymentChannelType: to.Ptr(armsaas.PaymentChannelTypeSubscriptionDelegated),
	// 		PublisherID: to.Ptr("microsoft-contoso"),
	// 		SaasResourceName: to.Ptr("MyContosoSubscription"),
	// 		SKUID: to.Ptr("premium"),
	// 		Created: to.Ptr("2021-01-01T08:30:10.1234567Z"),
	// 		IsFreeTrial: to.Ptr(false),
	// 		LastModified: to.Ptr("2020-01-01T08:35:05.7654321Z"),
	// 		Status: to.Ptr(armsaas.SaasResourceStatusSubscribed),
	// 		Term: &armsaas.PropertiesTerm{
	// 			EndDate: to.Ptr("2021-02-31T00:00:00Z"),
	// 			StartDate: to.Ptr("2021-01-01T00:00:00Z"),
	// 			TermUnit: to.Ptr("P1M"),
	// 		},
	// 	},
	// 	Tags: map[string]*string{
	// 	},
	// }
}
Output:

func (*Client) GetResource added in v0.2.0

func (client *Client) GetResource(ctx context.Context, resourceID string, options *ClientGetResourceOptions) (ClientGetResourceResponse, error)

GetResource - Gets information about the specified SaaS. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-01-beta

  • resourceID - The Saas resource ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
  • options - ClientGetResourceOptions contains the optional parameters for the Client.GetResource method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/saas/resource-manager/Microsoft.SaaS/preview/2018-03-01-beta/examples/saasV2/SaasGet.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/saas/armsaas"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsaas.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewClient().GetResource(ctx, "115c3523-1fae-757f-af86-7b27cfd29805", 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.Resource = armsaas.Resource{
	// 	Name: to.Ptr("diyakobo-transfer"),
	// 	Type: to.Ptr("Microsoft.SaaS/saasresources"),
	// 	ID: to.Ptr("/providers/Microsoft.SaaS/saasresources/115c3523-1fae-757f-af86-7b27cfd29805"),
	// 	Properties: &armsaas.ResourceProperties{
	// 		OfferID: to.Ptr("microsofthealthcarebot"),
	// 		PaymentChannelMetadata: map[string]*string{
	// 			"azureSubscriptionId": to.Ptr("155af98a-3205-47e7-883b-a2ab9db9f88d"),
	// 			"resourceId": to.Ptr("b25dba9a-1bd7-4600-9447-3d27d11a6477"),
	// 		},
	// 		PublisherID: to.Ptr("microsoft-hcb"),
	// 		SaasResourceName: to.Ptr("diyakobo-transfer"),
	// 		SKUID: to.Ptr("free"),
	// 		Created: to.Ptr("2020-10-12T05:08:40.9235607Z"),
	// 		IsFreeTrial: to.Ptr(false),
	// 		LastModified: to.Ptr("2020-11-12T21:25:40.2736665Z"),
	// 		Status: to.Ptr(armsaas.SaasResourceStatusSubscribed),
	// 		Term: &armsaas.PropertiesTerm{
	// 			EndDate: to.Ptr("2020-12-11T00:00:00Z"),
	// 			StartDate: to.Ptr("2020-11-12T00:00:00Z"),
	// 			TermUnit: to.Ptr("P1M"),
	// 		},
	// 	},
	// 	Tags: map[string]*string{
	// 	},
	// }
}
Output:

type ClientBeginCreateResourceOptions added in v0.2.0

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

ClientBeginCreateResourceOptions contains the optional parameters for the Client.BeginCreateResource method.

type ClientBeginDeleteOptions added in v0.2.0

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

ClientBeginDeleteOptions contains the optional parameters for the Client.BeginDelete method.

type ClientBeginUpdateResourceOptions added in v0.2.0

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

ClientBeginUpdateResourceOptions contains the optional parameters for the Client.BeginUpdateResource method.

type ClientCreateResourceResponse added in v0.2.0

type ClientCreateResourceResponse struct {
	// SaaS REST API resource definition.
	Resource
}

ClientCreateResourceResponse contains the response from method Client.BeginCreateResource.

type ClientDeleteResponse added in v0.2.0

type ClientDeleteResponse struct {
}

ClientDeleteResponse contains the response from method Client.BeginDelete.

type ClientFactory added in v0.6.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 v0.6.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 Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewApplicationsClient added in v0.6.0

func (c *ClientFactory) NewApplicationsClient() *ApplicationsClient

NewApplicationsClient creates a new instance of ApplicationsClient.

func (*ClientFactory) NewClient added in v0.6.0

func (c *ClientFactory) NewClient() *Client

NewClient creates a new instance of Client.

func (*ClientFactory) NewOperationClient added in v0.6.0

func (c *ClientFactory) NewOperationClient() *OperationClient

NewOperationClient creates a new instance of OperationClient.

func (*ClientFactory) NewOperationsClient added in v0.6.0

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewResourcesClient added in v0.6.0

func (c *ClientFactory) NewResourcesClient() *ResourcesClient

NewResourcesClient creates a new instance of ResourcesClient.

func (*ClientFactory) NewSubscriptionLevelClient added in v0.6.0

func (c *ClientFactory) NewSubscriptionLevelClient() *SubscriptionLevelClient

NewSubscriptionLevelClient creates a new instance of SubscriptionLevelClient.

type ClientGetResourceOptions added in v0.2.0

type ClientGetResourceOptions struct {
}

ClientGetResourceOptions contains the optional parameters for the Client.GetResource method.

type ClientGetResourceResponse added in v0.2.0

type ClientGetResourceResponse struct {
	// SaaS REST API resource definition.
	Resource
}

ClientGetResourceResponse contains the response from method Client.GetResource.

type ClientUpdateResourceResponse added in v0.2.0

type ClientUpdateResourceResponse struct {
	// SaaS REST API resource definition.
	Resource
}

ClientUpdateResourceResponse contains the response from method Client.BeginUpdateResource.

type CreationProperties added in v0.2.0

type CreationProperties struct {
	// Whether the SaaS subscription will auto renew upon term end.
	AutoRenew *bool

	// The offer id.
	OfferID *string

	// The metadata about the SaaS subscription such as the AzureSubscriptionId and ResourceUri.
	PaymentChannelMetadata map[string]*string

	// The Payment channel for the SaasSubscription.
	PaymentChannelType *PaymentChannelType

	// The publisher id.
	PublisherID *string

	// The environment in the publisher side for this resource.
	PublisherTestEnvironment *string

	// The seat count.
	Quantity *float32

	// The plan id.
	SKUID *string

	// The SaaS resource name.
	SaasResourceName *string

	// The saas session id used for dev service migration request.
	SaasSessionID *string

	// The saas subscription id used for tenant to subscription level migration request.
	SaasSubscriptionID *string

	// The current Term id.
	TermID *string
}

CreationProperties - properties for creation saas

func (CreationProperties) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type CreationProperties.

func (*CreationProperties) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type CreationProperties.

type DeleteOptions

type DeleteOptions struct {
	// the feedback
	Feedback *string

	// The reasonCode
	ReasonCode *float32

	// whether it is unsubscribeOnly
	UnsubscribeOnly *bool
}

DeleteOptions - delete Options

func (DeleteOptions) MarshalJSON added in v0.6.0

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

MarshalJSON implements the json.Marshaller interface for type DeleteOptions.

func (*DeleteOptions) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type DeleteOptions.

type ErrorAdditionalInfo

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info any

	// READ-ONLY; The additional info type.
	Type *string
}

ErrorAdditionalInfo - The resource management error additional info.

func (ErrorAdditionalInfo) MarshalJSON added in v0.6.0

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

MarshalJSON implements the json.Marshaller interface for type ErrorAdditionalInfo.

func (*ErrorAdditionalInfo) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorAdditionalInfo.

type ErrorDetail

type ErrorDetail struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo

	// READ-ONLY; The error code.
	Code *string

	// READ-ONLY; The error details.
	Details []*ErrorDetail

	// READ-ONLY; The error message.
	Message *string

	// READ-ONLY; The error target.
	Target *string
}

ErrorDetail - The error detail.

func (ErrorDetail) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

func (*ErrorDetail) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorDetail.

type ErrorResponse

type ErrorResponse struct {
	// The error object.
	Error *ErrorDetail
}

ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

func (ErrorResponse) MarshalJSON added in v0.6.0

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

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

func (*ErrorResponse) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponse.

type MoveResource

type MoveResource struct {
	// The resource uris to move
	Resources []*string

	// The target resource group uri for the move
	TargetResourceGroup *string
}

MoveResource - Resource Move Options

func (MoveResource) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type MoveResource.

func (*MoveResource) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type MoveResource.

type OperationClient added in v0.2.0

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

OperationClient contains the methods for the SaaSOperation group. Don't use this type directly, use NewOperationClient() instead.

func NewOperationClient added in v0.2.0

func NewOperationClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationClient, error)

NewOperationClient creates a new instance of OperationClient with the specified values.

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

func (*OperationClient) BeginGet added in v0.2.0

BeginGet - Gets information about the specified operation progress. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-01-beta

  • operationID - the operation Id parameter.
  • options - OperationClientBeginGetOptions contains the optional parameters for the OperationClient.BeginGet method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/saas/resource-manager/Microsoft.SaaS/preview/2018-03-01-beta/examples/OperationResults/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/saas/armsaas"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsaas.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewOperationClient().BeginGet(ctx, "5f35cb4c-8065-45b3-9116-5ba335462e95", 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.Resource = armsaas.Resource{
	// 	Name: to.Ptr("diyakobo-transfer"),
	// 	Type: to.Ptr("Microsoft.SaaS/saasresources"),
	// 	ID: to.Ptr("/providers/Microsoft.SaaS/saasresources/115c3523-1fae-757f-af86-7b27cfd29805"),
	// 	Properties: &armsaas.ResourceProperties{
	// 		OfferID: to.Ptr("microsofthealthcarebot"),
	// 		PaymentChannelMetadata: map[string]*string{
	// 			"azureSubscriptionId": to.Ptr("155af98a-3205-47e7-883b-a2ab9db9f88d"),
	// 			"resourceId": to.Ptr("b25dba9a-1bd7-4600-9447-3d27d11a6477"),
	// 		},
	// 		PublisherID: to.Ptr("microsoft-hcb"),
	// 		SaasResourceName: to.Ptr("diyakobo-transfer"),
	// 		SKUID: to.Ptr("free"),
	// 		Created: to.Ptr("2020-10-12T05:08:40.9235607Z"),
	// 		IsFreeTrial: to.Ptr(false),
	// 		LastModified: to.Ptr("2020-11-12T21:25:40.2736665Z"),
	// 		Status: to.Ptr(armsaas.SaasResourceStatusSubscribed),
	// 		Term: &armsaas.PropertiesTerm{
	// 			EndDate: to.Ptr("2020-12-11T00:00:00Z"),
	// 			StartDate: to.Ptr("2020-11-12T00:00:00Z"),
	// 			TermUnit: to.Ptr("P1M"),
	// 		},
	// 	},
	// 	Tags: map[string]*string{
	// 	},
	// }
}
Output:

type OperationClientBeginGetOptions added in v0.2.0

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

OperationClientBeginGetOptions contains the optional parameters for the OperationClient.BeginGet method.

type OperationClientGetResponse added in v0.2.0

type OperationClientGetResponse struct {
	// SaaS REST API resource definition.
	Resource
}

OperationClientGetResponse contains the response from method OperationClient.BeginGet.

type OperationsClient

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

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

func NewOperationsClient

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

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

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

func (*OperationsClient) NewListPager added in v0.4.0

NewListPager - Gets all SaaS app operations.

Generated from API version 2018-03-01-beta

  • 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/saas/resource-manager/Microsoft.SaaS/preview/2018-03-01-beta/examples/saasV1/SaaSGetOperations.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/saas/armsaas"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsaas.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.AppOperationsResponseWithContinuation = armsaas.AppOperationsResponseWithContinuation{
		// 	Value: []*armsaas.AppOperation{
		// 		{
		// 			Name: to.Ptr("Microsoft.SaaS/register/action"),
		// 			Display: &armsaas.AppOperationDisplay{
		// 				Description: to.Ptr("Register Saas resource provider in the tenant"),
		// 				Operation: to.Ptr("Register SaaS resource provider"),
		// 				Provider: to.Ptr("Microsoft"),
		// 				Resource: to.Ptr("SaaS Resources"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.SaaS/saasresources/read"),
		// 			Display: &armsaas.AppOperationDisplay{
		// 				Description: to.Ptr("Get all SaaS resources or one resource"),
		// 				Operation: to.Ptr("Get SaaS Resources"),
		// 				Provider: to.Ptr("Microsoft"),
		// 				Resource: to.Ptr("SaaS Resources"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.SaaS/saasresources/write"),
		// 			Display: &armsaas.AppOperationDisplay{
		// 				Description: to.Ptr("Create or Update a SaaS resource"),
		// 				Operation: to.Ptr("Create or Update a SaaS resource"),
		// 				Provider: to.Ptr("Microsoft"),
		// 				Resource: to.Ptr("SaaS Resources"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.SaaS/saasresources/delete"),
		// 			Display: &armsaas.AppOperationDisplay{
		// 				Description: to.Ptr("Delete a SaaS Resource"),
		// 				Operation: to.Ptr("Delete a SaaS Resource"),
		// 				Provider: to.Ptr("Microsoft"),
		// 				Resource: to.Ptr("SaaS Resources"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.SaaS/resources/read"),
		// 			Display: &armsaas.AppOperationDisplay{
		// 				Description: to.Ptr("Get one resource"),
		// 				Operation: to.Ptr("Get SaaS Subscription Level Resources"),
		// 				Provider: to.Ptr("Microsoft"),
		// 				Resource: to.Ptr("SaaS Subscription Level Resources"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.SaaS/resources/write"),
		// 			Display: &armsaas.AppOperationDisplay{
		// 				Description: to.Ptr("Create or Update a SaaS Subscription Level resource"),
		// 				Operation: to.Ptr("Create or Update a SaaS Subscription Level resource"),
		// 				Provider: to.Ptr("Microsoft"),
		// 				Resource: to.Ptr("SaaS Subscription Level Resources"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.SaaS/resources/delete"),
		// 			Display: &armsaas.AppOperationDisplay{
		// 				Description: to.Ptr("Delete a SaaS Subscription Level Resource"),
		// 				Operation: to.Ptr("Delete a SaaS Subscription Level Resource"),
		// 				Provider: to.Ptr("Microsoft"),
		// 				Resource: to.Ptr("SaaS Subscription Level Resources"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.SaaS/saasresources/listaccesstoken/action"),
		// 			Display: &armsaas.AppOperationDisplay{
		// 				Description: to.Ptr("Get the access Token for a SaaS resource"),
		// 				Operation: to.Ptr("Get the access Token"),
		// 				Provider: to.Ptr("Microsoft"),
		// 				Resource: to.Ptr("SaaS Resources"),
		// 			},
		// 	}},
		// }
	}
}
Output:

type OperationsClientListOptions added in v0.2.0

type OperationsClientListOptions struct {
}

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

type OperationsClientListResponse added in v0.2.0

type OperationsClientListResponse struct {
	// saas app operation response with continuation.
	AppOperationsResponseWithContinuation
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager.

type PaymentChannelType

type PaymentChannelType string

PaymentChannelType - The Payment channel for the SaasSubscription.

const (
	PaymentChannelTypeCustomerDelegated     PaymentChannelType = "CustomerDelegated"
	PaymentChannelTypeSubscriptionDelegated PaymentChannelType = "SubscriptionDelegated"
)

func PossiblePaymentChannelTypeValues

func PossiblePaymentChannelTypeValues() []PaymentChannelType

PossiblePaymentChannelTypeValues returns the possible values for the PaymentChannelType const type.

type Properties added in v0.2.0

type Properties struct {
	// Whether the current term is a Free Trial term
	IsFreeTrial *bool

	// The last modifier date if this resource.
	LastModified *string

	// The SaaS Subscription Status.
	Status *SaasResourceStatus

	// The current Term object.
	Term *PropertiesTerm

	// READ-ONLY; The created date of this resource.
	Created *string
}

Properties - saas resource properties

func (Properties) MarshalJSON added in v0.6.0

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

MarshalJSON implements the json.Marshaller interface for type Properties.

func (*Properties) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type Properties.

type PropertiesTerm added in v0.2.0

type PropertiesTerm struct {
	// The end date of the current term
	EndDate *string

	// The start date of the current term
	StartDate *string

	// The unit indicating Monthly / Yearly
	TermUnit *string
}

PropertiesTerm - The current Term object.

func (PropertiesTerm) MarshalJSON added in v0.6.0

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

MarshalJSON implements the json.Marshaller interface for type PropertiesTerm.

func (*PropertiesTerm) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type PropertiesTerm.

type Resource added in v0.2.0

type Resource struct {
	// saas properties
	Properties *ResourceProperties

	// the resource tags.
	Tags map[string]*string

	// READ-ONLY; The resource uri
	ID *string

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

	// READ-ONLY; Resource type.
	Type *string
}

Resource - SaaS REST API resource definition.

func (Resource) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type Resource.

func (*Resource) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type Resource.

type ResourceCreation added in v0.2.0

type ResourceCreation struct {
	// Resource location. Only value allowed for SaaS is 'global'
	Location *string

	// The resource name
	Name *string

	// Properties of the SaaS resource that are relevant for creation.
	Properties *CreationProperties

	// the resource tags.
	Tags map[string]*string

	// READ-ONLY; The resource uri
	ID *string

	// READ-ONLY; Resource type.
	Type *string
}

ResourceCreation - SaaS REST API resource definition for creation.

func (ResourceCreation) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type ResourceCreation.

func (*ResourceCreation) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceCreation.

type ResourceProperties added in v0.2.0

type ResourceProperties struct {
	// Whether the SaaS subscription will auto renew upon term end.
	AutoRenew *bool

	// Whether the current term is a Free Trial term
	IsFreeTrial *bool

	// The last modifier date if this resource.
	LastModified *string

	// The offer id.
	OfferID *string

	// The metadata about the SaaS subscription such as the AzureSubscriptionId and ResourceUri.
	PaymentChannelMetadata map[string]*string

	// The Payment channel for the SaasSubscription.
	PaymentChannelType *PaymentChannelType

	// The publisher id.
	PublisherID *string

	// The environment in the publisher side for this resource.
	PublisherTestEnvironment *string

	// The seat count.
	Quantity *float32

	// The plan id.
	SKUID *string

	// The SaaS resource name.
	SaasResourceName *string

	// The saas session id used for dev service migration request.
	SaasSessionID *string

	// The saas subscription id used for tenant to subscription level migration request.
	SaasSubscriptionID *string

	// The SaaS Subscription Status.
	Status *SaasResourceStatus

	// The current Term object.
	Term *PropertiesTerm

	// The current Term id.
	TermID *string

	// READ-ONLY; The created date of this resource.
	Created *string
}

ResourceProperties - saas properties

func (ResourceProperties) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type ResourceProperties.

func (*ResourceProperties) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProperties.

type ResourceResponseWithContinuation added in v0.2.0

type ResourceResponseWithContinuation struct {
	// the next link to query to get the remaining results.
	NextLink *string

	// the value of response.
	Value []*Resource
}

ResourceResponseWithContinuation - saas resources response with continuation.

func (ResourceResponseWithContinuation) MarshalJSON added in v0.2.0

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

MarshalJSON implements the json.Marshaller interface for type ResourceResponseWithContinuation.

func (*ResourceResponseWithContinuation) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceResponseWithContinuation.

type ResourcesClient added in v0.2.0

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

ResourcesClient contains the methods for the SaasResources group. Don't use this type directly, use NewResourcesClient() instead.

func NewResourcesClient added in v0.2.0

func NewResourcesClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*ResourcesClient, error)

NewResourcesClient creates a new instance of ResourcesClient with the specified values.

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

func (*ResourcesClient) ListAccessToken added in v0.2.0

ListAccessToken - Gets the ISV access token for a SaaS resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-01-beta

  • resourceID - The Saas resource ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
  • options - ResourcesClientListAccessTokenOptions contains the optional parameters for the ResourcesClient.ListAccessToken method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/saas/resource-manager/Microsoft.SaaS/preview/2018-03-01-beta/examples/saasV2/ListAccessTokenPost.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/saas/armsaas"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsaas.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewResourcesClient().ListAccessToken(ctx, "c825645b-e31b-9cf4-1cee-2aba9e58bc7c", 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.AccessTokenResult = armsaas.AccessTokenResult{
	// 	PublisherOfferBaseURI: to.Ptr("https://contoso.website.com/api/v1/marketplace/azure/common/auth"),
	// 	Token: to.Ptr("jyhAtr3AiFTXO0QsEkYizsNzqIAUJ+E0M1SXhl4E5hwAl7+GJT6t+dEwuWpSizgR0Vn6dMhzpS94JRzkUh2Xuq5L1QDgmDkDUeIikTFNviwtwxtF8CwipcB49rq5d8whmVp0CmWEjd/FzU0vvlikBRuy+asxC1UhXv6XxBkSxkZKj29AAFiGgsgRvXIld47C"),
	// }
}
Output:

func (*ResourcesClient) NewListPager added in v0.4.0

NewListPager - Get All Resources

Generated from API version 2018-03-01-beta

  • options - ResourcesClientListOptions contains the optional parameters for the ResourcesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/saas/resource-manager/Microsoft.SaaS/preview/2018-03-01-beta/examples/saasV2/SaaSGetAllResources.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/saas/armsaas"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsaas.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewResourcesClient().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.ResourceResponseWithContinuation = armsaas.ResourceResponseWithContinuation{
		// 	Value: []*armsaas.Resource{
		// 		{
		// 			Name: to.Ptr("diyakobo-transfer"),
		// 			Type: to.Ptr("Microsoft.SaaS/saasresources"),
		// 			ID: to.Ptr("/providers/Microsoft.SaaS/saasresources/115c3523-1fae-757f-af86-7b27cfd29805"),
		// 			Properties: &armsaas.ResourceProperties{
		// 				OfferID: to.Ptr("microsofthealthcarebot"),
		// 				PaymentChannelMetadata: map[string]*string{
		// 					"azureSubscriptionId": to.Ptr("155af98a-3205-47e7-883b-a2ab9db9f88d"),
		// 					"resourceId": to.Ptr("b25dba9a-1bd7-4600-9447-3d27d11a6477"),
		// 				},
		// 				PublisherID: to.Ptr("microsoft-hcb"),
		// 				SaasResourceName: to.Ptr("diyakobo-transfer"),
		// 				SKUID: to.Ptr("free"),
		// 				Created: to.Ptr("2020-10-12T05:08:40.9235607Z"),
		// 				IsFreeTrial: to.Ptr(false),
		// 				LastModified: to.Ptr("2020-11-12T21:25:40.2736665Z"),
		// 				Status: to.Ptr(armsaas.SaasResourceStatusSubscribed),
		// 				Term: &armsaas.PropertiesTerm{
		// 					EndDate: to.Ptr("2020-12-11T00:00:00Z"),
		// 					StartDate: to.Ptr("2020-11-12T00:00:00Z"),
		// 					TermUnit: to.Ptr("P1M"),
		// 				},
		// 			},
		// 			Tags: map[string]*string{
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("test-transfer"),
		// 			Type: to.Ptr("Microsoft.SaaS/saasresources"),
		// 			ID: to.Ptr("/providers/Microsoft.SaaS/saasresources/7a4a733c-2204-ee2c-2f51-47c2dfbcb7fd"),
		// 			Properties: &armsaas.ResourceProperties{
		// 				OfferID: to.Ptr("microsofthealthcarebot"),
		// 				PaymentChannelMetadata: map[string]*string{
		// 					"azureSubscriptionId": to.Ptr("155af98a-3205-47e7-883b-a2ab9db9f88d"),
		// 					"resourceId": to.Ptr("f5816b76-67e3-45e1-b331-91fbb021e068"),
		// 				},
		// 				PublisherID: to.Ptr("microsoft-hcb"),
		// 				SaasResourceName: to.Ptr("test-transfer"),
		// 				SKUID: to.Ptr("free"),
		// 				Created: to.Ptr("2020-09-30T16:45:41.2981172Z"),
		// 				IsFreeTrial: to.Ptr(false),
		// 				LastModified: to.Ptr("2020-10-30T16:22:15.4319475Z"),
		// 				Status: to.Ptr(armsaas.SaasResourceStatusSubscribed),
		// 				Term: &armsaas.PropertiesTerm{
		// 					EndDate: to.Ptr("2020-11-29T00:00:00Z"),
		// 					StartDate: to.Ptr("2020-10-30T00:00:00Z"),
		// 					TermUnit: to.Ptr("P1M"),
		// 				},
		// 			},
		// 			Tags: map[string]*string{
		// 			},
		// 	}},
		// }
	}
}
Output:

type ResourcesClientListAccessTokenOptions added in v0.2.0

type ResourcesClientListAccessTokenOptions struct {
}

ResourcesClientListAccessTokenOptions contains the optional parameters for the ResourcesClient.ListAccessToken method.

type ResourcesClientListAccessTokenResponse added in v0.2.0

type ResourcesClientListAccessTokenResponse struct {
	// the ISV access token result response.
	AccessTokenResult
}

ResourcesClientListAccessTokenResponse contains the response from method ResourcesClient.ListAccessToken.

type ResourcesClientListOptions added in v0.2.0

type ResourcesClientListOptions struct {
}

ResourcesClientListOptions contains the optional parameters for the ResourcesClient.NewListPager method.

type ResourcesClientListResponse added in v0.2.0

type ResourcesClientListResponse struct {
	// saas resources response with continuation.
	ResourceResponseWithContinuation
}

ResourcesClientListResponse contains the response from method ResourcesClient.NewListPager.

type Result

type Result struct {
	// Sample property of type string
	SampleProperty *string
}

Result - Sample result definition

func (Result) MarshalJSON added in v0.6.0

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

MarshalJSON implements the json.Marshaller interface for type Result.

func (*Result) UnmarshalJSON added in v0.6.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type Result.

type SaasAppStatus

type SaasAppStatus string

SaasAppStatus - the Saas resource status.

const (
	SaasAppStatusDeactivated  SaasAppStatus = "Deactivated"
	SaasAppStatusPending      SaasAppStatus = "Pending"
	SaasAppStatusSubscribed   SaasAppStatus = "Subscribed"
	SaasAppStatusSuspended    SaasAppStatus = "Suspended"
	SaasAppStatusUnsubscribed SaasAppStatus = "Unsubscribed"
)

func PossibleSaasAppStatusValues

func PossibleSaasAppStatusValues() []SaasAppStatus

PossibleSaasAppStatusValues returns the possible values for the SaasAppStatus const type.

type SaasResourceStatus

type SaasResourceStatus string

SaasResourceStatus - The SaaS Subscription Status.

const (
	SaasResourceStatusNotStarted              SaasResourceStatus = "NotStarted"
	SaasResourceStatusPendingFulfillmentStart SaasResourceStatus = "PendingFulfillmentStart"
	SaasResourceStatusSubscribed              SaasResourceStatus = "Subscribed"
	SaasResourceStatusSuspended               SaasResourceStatus = "Suspended"
	SaasResourceStatusUnsubscribed            SaasResourceStatus = "Unsubscribed"
)

func PossibleSaasResourceStatusValues

func PossibleSaasResourceStatusValues() []SaasResourceStatus

PossibleSaasResourceStatusValues returns the possible values for the SaasResourceStatus const type.

type SubscriptionLevelClient added in v0.2.0

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

SubscriptionLevelClient contains the methods for the SaasSubscriptionLevel group. Don't use this type directly, use NewSubscriptionLevelClient() instead.

func NewSubscriptionLevelClient added in v0.2.0

func NewSubscriptionLevelClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SubscriptionLevelClient, error)

NewSubscriptionLevelClient creates a new instance of SubscriptionLevelClient with the specified values.

  • subscriptionID - The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SubscriptionLevelClient) BeginCreateOrUpdate added in v0.2.0

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

Generated from API version 2018-03-01-beta

  • resourceGroupName - The name of the resource group.
  • resourceName - The name of the resource.
  • parameters - Parameters supplied to the create or update subscription level saas operation.
  • options - SubscriptionLevelClientBeginCreateOrUpdateOptions contains the optional parameters for the SubscriptionLevelClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/saas/resource-manager/Microsoft.SaaS/preview/2018-03-01-beta/examples/saasSubscriptionLevel/SaasPut.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/saas/armsaas"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsaas.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSubscriptionLevelClient().BeginCreateOrUpdate(ctx, "my-saas-rg", "MyContosoSubscription", armsaas.ResourceCreation{
		Name:     to.Ptr("MyContosoSubscription"),
		Location: to.Ptr("global"),
		Properties: &armsaas.CreationProperties{
			OfferID: to.Ptr("contosoOffer"),
			PaymentChannelMetadata: map[string]*string{
				"AzureSubscriptionId": to.Ptr("155af98a-3205-47e7-883b-a2ab9db9f88d"),
			},
			PaymentChannelType: to.Ptr(armsaas.PaymentChannelTypeSubscriptionDelegated),
			PublisherID:        to.Ptr("microsoft-contoso"),
			SaasResourceName:   to.Ptr("MyContosoSubscription"),
			SKUID:              to.Ptr("free"),
			TermID:             to.Ptr("hjdtn7tfnxcy"),
		},
	}, 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.Resource = armsaas.Resource{
	// 	Name: to.Ptr("MyContosoSubscription"),
	// 	Type: to.Ptr("Microsoft.SaaS/resources"),
	// 	ID: to.Ptr("/subscriptions/c825645b-e31b-9cf4-1cee-2aba9e58bc7c/resourceGroups/my-saas-rg/providers/Microsoft.SaaS/resources/MyContosoSubscription"),
	// 	Properties: &armsaas.ResourceProperties{
	// 		AutoRenew: to.Ptr(true),
	// 		OfferID: to.Ptr("contosoOffer"),
	// 		PaymentChannelMetadata: map[string]*string{
	// 			"azureSubscriptionId": to.Ptr("c825645b-e31b-9cf4-1cee-2aba9e58bc7c"),
	// 			"resourceId": to.Ptr("263ebe8c-3621-4ac0-a6ba-f1419bfb9166"),
	// 		},
	// 		PaymentChannelType: to.Ptr(armsaas.PaymentChannelTypeSubscriptionDelegated),
	// 		PublisherID: to.Ptr("microsoft-contoso"),
	// 		SaasResourceName: to.Ptr("MyContosoSubscription"),
	// 		SKUID: to.Ptr("free"),
	// 		Created: to.Ptr("2021-01-01T08:30:10.1234567Z"),
	// 		IsFreeTrial: to.Ptr(false),
	// 		LastModified: to.Ptr("2020-01-01T08:35:05.7654321Z"),
	// 		Status: to.Ptr(armsaas.SaasResourceStatusSubscribed),
	// 		Term: &armsaas.PropertiesTerm{
	// 			EndDate: to.Ptr("2021-02-31T00:00:00Z"),
	// 			StartDate: to.Ptr("2021-01-01T00:00:00Z"),
	// 			TermUnit: to.Ptr("P1M"),
	// 		},
	// 	},
	// 	Tags: map[string]*string{
	// 	},
	// }
}
Output:

func (*SubscriptionLevelClient) BeginDelete added in v0.2.0

BeginDelete - Deletes the specified SaaS. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-01-beta

  • resourceGroupName - The name of the resource group.
  • resourceName - The name of the resource.
  • options - SubscriptionLevelClientBeginDeleteOptions contains the optional parameters for the SubscriptionLevelClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/saas/resource-manager/Microsoft.SaaS/preview/2018-03-01-beta/examples/saasSubscriptionLevel/SaasDelete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/saas/armsaas"
)

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

func (*SubscriptionLevelClient) BeginMoveResources added in v0.2.0

BeginMoveResources - Move a specified Subscription Level SaaS. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-01-beta

  • resourceGroupName - The name of the resource group.
  • moveResourceParameter - Object that represents the resources to move.
  • options - SubscriptionLevelClientBeginMoveResourcesOptions contains the optional parameters for the SubscriptionLevelClient.BeginMoveResources method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/saas/resource-manager/Microsoft.SaaS/preview/2018-03-01-beta/examples/saasSubscriptionLevel/ResourceMove.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/saas/armsaas"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsaas.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSubscriptionLevelClient().BeginMoveResources(ctx, "my-saas-rg", armsaas.MoveResource{
		Resources: []*string{
			to.Ptr("/subscriptions/c825645b-e31b-9cf4-1cee-2aba9e58bc7c/resourceGroups/my-saas-rg/providers/Microsoft.SaaS/resources/saas1"),
			to.Ptr("/subscriptions/c825645b-e31b-9cf4-1cee-2aba9e58bc7c/resourceGroups/my-saas-rg/providers/Microsoft.SaaS/resources/saas2"),
			to.Ptr("/subscriptions/c825645b-e31b-9cf4-1cee-2aba9e58bc7c/resourceGroups/my-saas-rg/providers/Microsoft.SaaS/resources/saas3")},
		TargetResourceGroup: to.Ptr("/subscriptions/5122d0a3-1e10-4baf-bdc5-c2a452489525/resourceGroups/new-saas-rg"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*SubscriptionLevelClient) BeginUpdate added in v0.2.0

BeginUpdate - Updates a SaaS Subscription Level resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-01-beta

  • resourceGroupName - The name of the resource group.
  • resourceName - The name of the resource.
  • parameters - Parameters supplied to the update saas operation.
  • options - SubscriptionLevelClientBeginUpdateOptions contains the optional parameters for the SubscriptionLevelClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/saas/resource-manager/Microsoft.SaaS/preview/2018-03-01-beta/examples/saasSubscriptionLevel/SaasPatch.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/saas/armsaas"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsaas.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSubscriptionLevelClient().BeginUpdate(ctx, "my-saas-rg", "MyContosoSubscription", armsaas.ResourceCreation{
		Properties: &armsaas.CreationProperties{
			SKUID: to.Ptr("premium"),
		},
		Tags: map[string]*string{},
	}, 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.Resource = armsaas.Resource{
	// 	Name: to.Ptr("MyContosoSubscription"),
	// 	Type: to.Ptr("Microsoft.SaaS/resources"),
	// 	ID: to.Ptr("/subscriptions/c825645b-e31b-9cf4-1cee-2aba9e58bc7c/resourceGroups/my-saas-rg/providers/Microsoft.SaaS/resources/MyContosoSubscription"),
	// 	Properties: &armsaas.ResourceProperties{
	// 		AutoRenew: to.Ptr(true),
	// 		OfferID: to.Ptr("contosoOffer"),
	// 		PaymentChannelMetadata: map[string]*string{
	// 			"azureSubscriptionId": to.Ptr("c825645b-e31b-9cf4-1cee-2aba9e58bc7c"),
	// 			"resourceId": to.Ptr("263ebe8c-3621-4ac0-a6ba-f1419bfb9166"),
	// 		},
	// 		PaymentChannelType: to.Ptr(armsaas.PaymentChannelTypeSubscriptionDelegated),
	// 		PublisherID: to.Ptr("microsoft-contoso"),
	// 		SaasResourceName: to.Ptr("MyContosoSubscription"),
	// 		SKUID: to.Ptr("free"),
	// 		Created: to.Ptr("2021-01-01T08:30:10.1234567Z"),
	// 		IsFreeTrial: to.Ptr(false),
	// 		LastModified: to.Ptr("2020-01-01T08:35:05.7654321Z"),
	// 		Status: to.Ptr(armsaas.SaasResourceStatusSubscribed),
	// 		Term: &armsaas.PropertiesTerm{
	// 			EndDate: to.Ptr("2021-02-31T00:00:00Z"),
	// 			StartDate: to.Ptr("2021-01-01T00:00:00Z"),
	// 			TermUnit: to.Ptr("P1M"),
	// 		},
	// 	},
	// 	Tags: map[string]*string{
	// 	},
	// }
}
Output:

func (*SubscriptionLevelClient) BeginUpdateToUnsubscribed added in v0.2.0

BeginUpdateToUnsubscribed - Unsubscribe from a specified Subscription Level SaaS. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-01-beta

  • resourceGroupName - The name of the resource group.
  • resourceName - The name of the resource.
  • parameters - Parameters supplied to unsubscribe saas operation.
  • options - SubscriptionLevelClientBeginUpdateToUnsubscribedOptions contains the optional parameters for the SubscriptionLevelClient.BeginUpdateToUnsubscribed method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/saas/resource-manager/Microsoft.SaaS/preview/2018-03-01-beta/examples/saasSubscriptionLevel/SaasUnsubscribe.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/saas/armsaas"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsaas.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSubscriptionLevelClient().BeginUpdateToUnsubscribed(ctx, "my-saas-rg", "MyContosoSubscription", armsaas.DeleteOptions{
		Feedback:        to.Ptr("No longer need this SaaS"),
		ReasonCode:      to.Ptr[float32](0),
		UnsubscribeOnly: to.Ptr(true),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*SubscriptionLevelClient) Get added in v0.2.0

Get - Gets information about the specified Subscription Level SaaS. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-01-beta

  • resourceGroupName - The name of the resource group.
  • resourceName - The name of the resource.
  • options - SubscriptionLevelClientGetOptions contains the optional parameters for the SubscriptionLevelClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/saas/resource-manager/Microsoft.SaaS/preview/2018-03-01-beta/examples/saasSubscriptionLevel/SaasGet.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/saas/armsaas"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsaas.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSubscriptionLevelClient().Get(ctx, "my-saas-rg", "MyContosoSubscription", 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.Resource = armsaas.Resource{
	// 	Name: to.Ptr("MyContosoSubscription"),
	// 	Type: to.Ptr("Microsoft.SaaS/resources"),
	// 	ID: to.Ptr("/subscriptions/c825645b-e31b-9cf4-1cee-2aba9e58bc7c/resourceGroups/my-saas-rg/providers/Microsoft.SaaS/resources/MyContosoSubscription"),
	// 	Properties: &armsaas.ResourceProperties{
	// 		AutoRenew: to.Ptr(true),
	// 		OfferID: to.Ptr("contosoOffer"),
	// 		PaymentChannelMetadata: map[string]*string{
	// 			"azureSubscriptionId": to.Ptr("c825645b-e31b-9cf4-1cee-2aba9e58bc7c"),
	// 			"resourceId": to.Ptr("263ebe8c-3621-4ac0-a6ba-f1419bfb9166"),
	// 		},
	// 		PaymentChannelType: to.Ptr(armsaas.PaymentChannelTypeSubscriptionDelegated),
	// 		PublisherID: to.Ptr("microsoft-contoso"),
	// 		SaasResourceName: to.Ptr("MyContosoSubscription"),
	// 		SKUID: to.Ptr("free"),
	// 		Created: to.Ptr("2021-01-01T08:30:10.1234567Z"),
	// 		IsFreeTrial: to.Ptr(false),
	// 		LastModified: to.Ptr("2020-01-01T08:35:05.7654321Z"),
	// 		Status: to.Ptr(armsaas.SaasResourceStatusSubscribed),
	// 		Term: &armsaas.PropertiesTerm{
	// 			EndDate: to.Ptr("2021-02-31T00:00:00Z"),
	// 			StartDate: to.Ptr("2021-01-01T00:00:00Z"),
	// 			TermUnit: to.Ptr("P1M"),
	// 		},
	// 	},
	// 	Tags: map[string]*string{
	// 	},
	// }
}
Output:

func (*SubscriptionLevelClient) ListAccessToken added in v0.2.0

ListAccessToken - Gets the ISV access token for a specified Subscription Level SaaS. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-01-beta

  • resourceGroupName - The name of the resource group.
  • resourceName - The name of the resource.
  • options - SubscriptionLevelClientListAccessTokenOptions contains the optional parameters for the SubscriptionLevelClient.ListAccessToken method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/saas/resource-manager/Microsoft.SaaS/preview/2018-03-01-beta/examples/saasSubscriptionLevel/ListAccessTokenPost.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/saas/armsaas"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsaas.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSubscriptionLevelClient().ListAccessToken(ctx, "my-saas-rg", "MyContosoSubscription", 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.AccessTokenResult = armsaas.AccessTokenResult{
	// 	PublisherOfferBaseURI: to.Ptr("https://contoso.website.com/api/v1/marketplace/azure/common/auth"),
	// 	Token: to.Ptr("jyhAtr3AiFTXO0QsEkYizsNzqIAUJ+E0M1SXhl4E5hwAl7+GJT6t+dEwuWpSizgR0Vn6dMhzpS94JRzkUh2Xuq5L1QDgmDkDUeIikTFNviwtwxtF8CwipcB49rq5d8whmVp0CmWEjd/FzU0vvlikBRuy+asxC1UhXv6XxBkSxkZKj29AAFiGgsgRvXIld47C"),
	// }
}
Output:

func (*SubscriptionLevelClient) NewListByAzureSubscriptionPager added in v0.4.0

NewListByAzureSubscriptionPager - Gets information about all the Subscription Level SaaS in a certain Azure subscription.

Generated from API version 2018-03-01-beta

  • options - SubscriptionLevelClientListByAzureSubscriptionOptions contains the optional parameters for the SubscriptionLevelClient.NewListByAzureSubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/saas/resource-manager/Microsoft.SaaS/preview/2018-03-01-beta/examples/saasSubscriptionLevel/SaasGetAllInAzureSubscription.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/saas/armsaas"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsaas.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSubscriptionLevelClient().NewListByAzureSubscriptionPager(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.ResourceResponseWithContinuation = armsaas.ResourceResponseWithContinuation{
		// 	Value: []*armsaas.Resource{
		// 		{
		// 			Name: to.Ptr("MyContosoSubscription"),
		// 			Type: to.Ptr("Microsoft.SaaS/resources"),
		// 			ID: to.Ptr("/subscriptions/c825645b-e31b-9cf4-1cee-2aba9e58bc7c/resourceGroups/my-saas-rg/providers/Microsoft.SaaS/resources/MyContosoSubscription"),
		// 			Properties: &armsaas.ResourceProperties{
		// 				AutoRenew: to.Ptr(true),
		// 				OfferID: to.Ptr("contosoOffer"),
		// 				PaymentChannelMetadata: map[string]*string{
		// 					"azureSubscriptionId": to.Ptr("c825645b-e31b-9cf4-1cee-2aba9e58bc7c"),
		// 					"resourceId": to.Ptr("263ebe8c-3621-4ac0-a6ba-f1419bfb9166"),
		// 				},
		// 				PaymentChannelType: to.Ptr(armsaas.PaymentChannelTypeSubscriptionDelegated),
		// 				PublisherID: to.Ptr("microsoft-contoso"),
		// 				SaasResourceName: to.Ptr("MyContosoSubscription"),
		// 				SKUID: to.Ptr("free"),
		// 				Created: to.Ptr("2021-01-01T08:30:10.1234567Z"),
		// 				IsFreeTrial: to.Ptr(false),
		// 				LastModified: to.Ptr("2020-01-01T08:35:05.7654321Z"),
		// 				Status: to.Ptr(armsaas.SaasResourceStatusSubscribed),
		// 				Term: &armsaas.PropertiesTerm{
		// 					EndDate: to.Ptr("2021-02-31T00:00:00Z"),
		// 					StartDate: to.Ptr("2021-01-01T00:00:00Z"),
		// 					TermUnit: to.Ptr("P1M"),
		// 				},
		// 			},
		// 			Tags: map[string]*string{
		// 			},
		// 	}},
		// }
	}
}
Output:

func (*SubscriptionLevelClient) NewListByResourceGroupPager added in v0.4.0

NewListByResourceGroupPager - Gets information about all the Subscription Level SaaS in a certain resource group.

Generated from API version 2018-03-01-beta

  • resourceGroupName - The name of the resource group.
  • options - SubscriptionLevelClientListByResourceGroupOptions contains the optional parameters for the SubscriptionLevelClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/saas/resource-manager/Microsoft.SaaS/preview/2018-03-01-beta/examples/saasSubscriptionLevel/SaasGetAllInResourceGroup.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/saas/armsaas"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsaas.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSubscriptionLevelClient().NewListByResourceGroupPager("my-saas-rg", 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.ResourceResponseWithContinuation = armsaas.ResourceResponseWithContinuation{
		// 	Value: []*armsaas.Resource{
		// 		{
		// 			Name: to.Ptr("MyContosoSubscription"),
		// 			Type: to.Ptr("Microsoft.SaaS/resources"),
		// 			ID: to.Ptr("/subscriptions/c825645b-e31b-9cf4-1cee-2aba9e58bc7c/resourceGroups/my-saas-rg/providers/Microsoft.SaaS/resources/MyContosoSubscription"),
		// 			Properties: &armsaas.ResourceProperties{
		// 				AutoRenew: to.Ptr(true),
		// 				OfferID: to.Ptr("contosoOffer"),
		// 				PaymentChannelMetadata: map[string]*string{
		// 					"azureSubscriptionId": to.Ptr("c825645b-e31b-9cf4-1cee-2aba9e58bc7c"),
		// 					"resourceId": to.Ptr("263ebe8c-3621-4ac0-a6ba-f1419bfb9166"),
		// 				},
		// 				PaymentChannelType: to.Ptr(armsaas.PaymentChannelTypeSubscriptionDelegated),
		// 				PublisherID: to.Ptr("microsoft-contoso"),
		// 				SaasResourceName: to.Ptr("MyContosoSubscription"),
		// 				SKUID: to.Ptr("free"),
		// 				Created: to.Ptr("2021-01-01T08:30:10.1234567Z"),
		// 				IsFreeTrial: to.Ptr(false),
		// 				LastModified: to.Ptr("2020-01-01T08:35:05.7654321Z"),
		// 				Status: to.Ptr(armsaas.SaasResourceStatusSubscribed),
		// 				Term: &armsaas.PropertiesTerm{
		// 					EndDate: to.Ptr("2021-02-31T00:00:00Z"),
		// 					StartDate: to.Ptr("2021-01-01T00:00:00Z"),
		// 					TermUnit: to.Ptr("P1M"),
		// 				},
		// 			},
		// 			Tags: map[string]*string{
		// 			},
		// 	}},
		// }
	}
}
Output:

func (*SubscriptionLevelClient) ValidateMoveResources added in v0.2.0

ValidateMoveResources - Validate whether a specified Subscription Level SaaS can be moved. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-01-beta

  • resourceGroupName - The name of the resource group.
  • moveResourceParameter - Object that represents the resources to move.
  • options - SubscriptionLevelClientValidateMoveResourcesOptions contains the optional parameters for the SubscriptionLevelClient.ValidateMoveResources method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/saas/resource-manager/Microsoft.SaaS/preview/2018-03-01-beta/examples/saasSubscriptionLevel/ValidateResourceMove.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/saas/armsaas"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsaas.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewSubscriptionLevelClient().ValidateMoveResources(ctx, "my-saas-rg", armsaas.MoveResource{
		Resources: []*string{
			to.Ptr("/subscriptions/c825645b-e31b-9cf4-1cee-2aba9e58bc7c/resourceGroups/my-saas-rg/providers/Microsoft.SaaS/resources/saas1"),
			to.Ptr("/subscriptions/c825645b-e31b-9cf4-1cee-2aba9e58bc7c/resourceGroups/my-saas-rg/providers/Microsoft.SaaS/resources/saas2"),
			to.Ptr("/subscriptions/c825645b-e31b-9cf4-1cee-2aba9e58bc7c/resourceGroups/my-saas-rg/providers/Microsoft.SaaS/resources/saas3")},
		TargetResourceGroup: to.Ptr("/subscriptions/5122d0a3-1e10-4baf-bdc5-c2a452489525/resourceGroups/new-saas-rg"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

type SubscriptionLevelClientBeginCreateOrUpdateOptions added in v0.2.0

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

SubscriptionLevelClientBeginCreateOrUpdateOptions contains the optional parameters for the SubscriptionLevelClient.BeginCreateOrUpdate method.

type SubscriptionLevelClientBeginDeleteOptions added in v0.2.0

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

SubscriptionLevelClientBeginDeleteOptions contains the optional parameters for the SubscriptionLevelClient.BeginDelete method.

type SubscriptionLevelClientBeginMoveResourcesOptions added in v0.2.0

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

SubscriptionLevelClientBeginMoveResourcesOptions contains the optional parameters for the SubscriptionLevelClient.BeginMoveResources method.

type SubscriptionLevelClientBeginUpdateOptions added in v0.2.0

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

SubscriptionLevelClientBeginUpdateOptions contains the optional parameters for the SubscriptionLevelClient.BeginUpdate method.

type SubscriptionLevelClientBeginUpdateToUnsubscribedOptions added in v0.2.0

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

SubscriptionLevelClientBeginUpdateToUnsubscribedOptions contains the optional parameters for the SubscriptionLevelClient.BeginUpdateToUnsubscribed method.

type SubscriptionLevelClientCreateOrUpdateResponse added in v0.2.0

type SubscriptionLevelClientCreateOrUpdateResponse struct {
	// SaaS REST API resource definition.
	Resource
}

SubscriptionLevelClientCreateOrUpdateResponse contains the response from method SubscriptionLevelClient.BeginCreateOrUpdate.

type SubscriptionLevelClientDeleteResponse added in v0.2.0

type SubscriptionLevelClientDeleteResponse struct {
}

SubscriptionLevelClientDeleteResponse contains the response from method SubscriptionLevelClient.BeginDelete.

type SubscriptionLevelClientGetOptions added in v0.2.0

type SubscriptionLevelClientGetOptions struct {
}

SubscriptionLevelClientGetOptions contains the optional parameters for the SubscriptionLevelClient.Get method.

type SubscriptionLevelClientGetResponse added in v0.2.0

type SubscriptionLevelClientGetResponse struct {
	// SaaS REST API resource definition.
	Resource
}

SubscriptionLevelClientGetResponse contains the response from method SubscriptionLevelClient.Get.

type SubscriptionLevelClientListAccessTokenOptions added in v0.2.0

type SubscriptionLevelClientListAccessTokenOptions struct {
}

SubscriptionLevelClientListAccessTokenOptions contains the optional parameters for the SubscriptionLevelClient.ListAccessToken method.

type SubscriptionLevelClientListAccessTokenResponse added in v0.2.0

type SubscriptionLevelClientListAccessTokenResponse struct {
	// the ISV access token result response.
	AccessTokenResult
}

SubscriptionLevelClientListAccessTokenResponse contains the response from method SubscriptionLevelClient.ListAccessToken.

type SubscriptionLevelClientListByAzureSubscriptionOptions added in v0.2.0

type SubscriptionLevelClientListByAzureSubscriptionOptions struct {
}

SubscriptionLevelClientListByAzureSubscriptionOptions contains the optional parameters for the SubscriptionLevelClient.NewListByAzureSubscriptionPager method.

type SubscriptionLevelClientListByAzureSubscriptionResponse added in v0.2.0

type SubscriptionLevelClientListByAzureSubscriptionResponse struct {
	// saas resources response with continuation.
	ResourceResponseWithContinuation
}

SubscriptionLevelClientListByAzureSubscriptionResponse contains the response from method SubscriptionLevelClient.NewListByAzureSubscriptionPager.

type SubscriptionLevelClientListByResourceGroupOptions added in v0.2.0

type SubscriptionLevelClientListByResourceGroupOptions struct {
}

SubscriptionLevelClientListByResourceGroupOptions contains the optional parameters for the SubscriptionLevelClient.NewListByResourceGroupPager method.

type SubscriptionLevelClientListByResourceGroupResponse added in v0.2.0

type SubscriptionLevelClientListByResourceGroupResponse struct {
	// saas resources response with continuation.
	ResourceResponseWithContinuation
}

SubscriptionLevelClientListByResourceGroupResponse contains the response from method SubscriptionLevelClient.NewListByResourceGroupPager.

type SubscriptionLevelClientMoveResourcesResponse added in v0.2.0

type SubscriptionLevelClientMoveResourcesResponse struct {
}

SubscriptionLevelClientMoveResourcesResponse contains the response from method SubscriptionLevelClient.BeginMoveResources.

type SubscriptionLevelClientUpdateResponse added in v0.2.0

type SubscriptionLevelClientUpdateResponse struct {
	// SaaS REST API resource definition.
	Resource
}

SubscriptionLevelClientUpdateResponse contains the response from method SubscriptionLevelClient.BeginUpdate.

type SubscriptionLevelClientUpdateToUnsubscribedResponse added in v0.2.0

type SubscriptionLevelClientUpdateToUnsubscribedResponse struct {
}

SubscriptionLevelClientUpdateToUnsubscribedResponse contains the response from method SubscriptionLevelClient.BeginUpdateToUnsubscribed.

type SubscriptionLevelClientValidateMoveResourcesOptions added in v0.2.0

type SubscriptionLevelClientValidateMoveResourcesOptions struct {
}

SubscriptionLevelClientValidateMoveResourcesOptions contains the optional parameters for the SubscriptionLevelClient.ValidateMoveResources method.

type SubscriptionLevelClientValidateMoveResourcesResponse added in v0.2.0

type SubscriptionLevelClientValidateMoveResourcesResponse struct {
}

SubscriptionLevelClientValidateMoveResourcesResponse contains the response from method SubscriptionLevelClient.ValidateMoveResources.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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