managementpartner

package
v67.1.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Nov 15, 2022 License: MIT Imports: 9 Imported by: 233

Documentation

Overview

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/managementpartner/armmanagementpartner(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/managementpartner/armmanagementpartner). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

Package managementpartner implements the Azure ARM Managementpartner service API version 2018-02-01.

This API describe ACE Provisioning ManagementPartner

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Managementpartner
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI string
}

BaseClient is the base client for Managementpartner.

func New 

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type Code 

type Code string

Code enumerates the values for code. 

const (
	// BadRequest ...
	BadRequest Code = "BadRequest"
	// Conflict ...
	Conflict Code = "Conflict"
	// NotFound ...
	NotFound Code = "NotFound"
)

func PossibleCodeValues 

func PossibleCodeValues() []Code

PossibleCodeValues returns an array of possible values for the Code const type.

type Error 

type Error struct {
	// Error - this is the ExtendedErrorInfo property
	Error *ExtendedErrorInfo `json:"error,omitempty"`
}

Error this is the management partner operations error

type ExtendedErrorInfo 

type ExtendedErrorInfo struct {
	// Code - this is the error response code. Possible values include: 'NotFound', 'Conflict', 'BadRequest'
	Code Code `json:"code,omitempty"`
	// Message - this is the extended error info message
	Message *string `json:"message,omitempty"`
}

ExtendedErrorInfo this is the extended error info

type OperationClient 

type OperationClient struct {
	BaseClient
}

OperationClient is the this API describe ACE Provisioning ManagementPartner

func NewOperationClient 

func NewOperationClient() OperationClient

NewOperationClient creates an instance of the OperationClient client.

func NewOperationClientWithBaseURI 

func NewOperationClientWithBaseURI(baseURI string) OperationClient

NewOperationClientWithBaseURI creates an instance of the OperationClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationClient) List 

func (client OperationClient) List(ctx context.Context) (result OperationListPage, err error)

List list all the operations.

func (OperationClient) ListComplete 

func (client OperationClient) ListComplete(ctx context.Context) (result OperationListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationClient) ListPreparer 

func (client OperationClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationClient) ListResponder 

func (client OperationClient) ListResponder(resp *http.Response) (result OperationList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationClient) ListSender 

func (client OperationClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type OperationDisplay 

type OperationDisplay struct {
	// Provider - the is management partner provider
	Provider *string `json:"provider,omitempty"`
	// Resource - the is management partner resource
	Resource *string `json:"resource,omitempty"`
	// Operation - the is management partner operation
	Operation *string `json:"operation,omitempty"`
	// Description - the is management partner operation description
	Description *string `json:"description,omitempty"`
}

OperationDisplay this is the management partner operation

type OperationList 

type OperationList struct {
	autorest.Response `json:"-"`
	// Value - this is the operation response list
	Value *[]OperationResponse `json:"value,omitempty"`
	// NextLink - Url to get the next page of items.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationList this is the management partner operations list

func (OperationList) IsEmpty 

func (ol OperationList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListIterator 

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

OperationListIterator provides access to a complete listing of OperationResponse values.

func NewOperationListIterator 

func NewOperationListIterator(page OperationListPage) OperationListIterator

Creates a new instance of the OperationListIterator type.

func (*OperationListIterator) Next 

func (iter *OperationListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListIterator) NextWithContext 

func (iter *OperationListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationListIterator) NotDone 

func (iter OperationListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationListIterator) Response 

func (iter OperationListIterator) Response() OperationList

Response returns the raw server response from the last page request.

func (OperationListIterator) Value 

func (iter OperationListIterator) Value() OperationResponse

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationListPage 

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

OperationListPage contains a page of OperationResponse values.

func NewOperationListPage 

func NewOperationListPage(cur OperationList, getNextPage func(context.Context, OperationList) (OperationList, error)) OperationListPage

Creates a new instance of the OperationListPage type.

func (*OperationListPage) Next 

func (page *OperationListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListPage) NextWithContext 

func (page *OperationListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationListPage) NotDone 

func (page OperationListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationListPage) Response 

func (page OperationListPage) Response() OperationList

Response returns the raw server response from the last page request.

func (OperationListPage) Values 

func (page OperationListPage) Values() []OperationResponse

Values returns the slice of values for the current page or nil if there are no values.

type OperationResponse 

type OperationResponse struct {
	// Name - this is the operation response name
	Name *string `json:"name,omitempty"`
	// Display - this is the operation display
	Display *OperationDisplay `json:"display,omitempty"`
	// Origin - the is operation response origin information
	Origin *string `json:"origin,omitempty"`
}

OperationResponse this is the management partner operations response

type PartnerClient 

type PartnerClient struct {
	BaseClient
}

PartnerClient is the this API describe ACE Provisioning ManagementPartner

func NewPartnerClient 

func NewPartnerClient() PartnerClient

NewPartnerClient creates an instance of the PartnerClient client.

func NewPartnerClientWithBaseURI 

func NewPartnerClientWithBaseURI(baseURI string) PartnerClient

NewPartnerClientWithBaseURI creates an instance of the PartnerClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (PartnerClient) Create 

func (client PartnerClient) Create(ctx context.Context, partnerID string) (result PartnerResponse, err error)

Create create a management partner for the objectId and tenantId. Parameters: partnerID - id of the Partner

func (PartnerClient) CreatePreparer 

func (client PartnerClient) CreatePreparer(ctx context.Context, partnerID string) (*http.Request, error)

CreatePreparer prepares the Create request.

func (PartnerClient) CreateResponder 

func (client PartnerClient) CreateResponder(resp *http.Response) (result PartnerResponse, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (PartnerClient) CreateSender 

func (client PartnerClient) CreateSender(req *http.Request) (*http.Response, error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (PartnerClient) Delete 

func (client PartnerClient) Delete(ctx context.Context, partnerID string) (result autorest.Response, err error)

Delete delete the management partner for the objectId and tenantId. Parameters: partnerID - id of the Partner

func (PartnerClient) DeletePreparer 

func (client PartnerClient) DeletePreparer(ctx context.Context, partnerID string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (PartnerClient) DeleteResponder 

func (client PartnerClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (PartnerClient) DeleteSender 

func (client PartnerClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (PartnerClient) Get 

func (client PartnerClient) Get(ctx context.Context, partnerID string) (result PartnerResponse, err error)

Get get the management partner using the partnerId, objectId and tenantId. Parameters: partnerID - id of the Partner

func (PartnerClient) GetPreparer 

func (client PartnerClient) GetPreparer(ctx context.Context, partnerID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (PartnerClient) GetResponder 

func (client PartnerClient) GetResponder(resp *http.Response) (result PartnerResponse, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (PartnerClient) GetSender 

func (client PartnerClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (PartnerClient) Update 

func (client PartnerClient) Update(ctx context.Context, partnerID string) (result PartnerResponse, err error)

Update update the management partner for the objectId and tenantId. Parameters: partnerID - id of the Partner

func (PartnerClient) UpdatePreparer 

func (client PartnerClient) UpdatePreparer(ctx context.Context, partnerID string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (PartnerClient) UpdateResponder 

func (client PartnerClient) UpdateResponder(resp *http.Response) (result PartnerResponse, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (PartnerClient) UpdateSender 

func (client PartnerClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type PartnerProperties 

type PartnerProperties struct {
	// PartnerID - This is the partner id
	PartnerID *string `json:"partnerId,omitempty"`
	// PartnerName - This is the partner name
	PartnerName *string `json:"partnerName,omitempty"`
	// TenantID - This is the tenant id.
	TenantID *string `json:"tenantId,omitempty"`
	// ObjectID - This is the object id.
	ObjectID *string `json:"objectId,omitempty"`
	// Version - This is the version.
	Version *int32 `json:"version,omitempty"`
	// UpdatedTime - This is the DateTime when the partner was updated.
	UpdatedTime *date.Time `json:"updatedTime,omitempty"`
	// CreatedTime - This is the DateTime when the partner was created.
	CreatedTime *date.Time `json:"createdTime,omitempty"`
	// State - This is the partner state. Possible values include: 'Active', 'Deleted'
	State State `json:"state,omitempty"`
}

PartnerProperties this is the management partner properties

type PartnerResponse 

type PartnerResponse struct {
	autorest.Response `json:"-"`
	// Etag - Type of the partner
	Etag *int32 `json:"etag,omitempty"`
	// ID - READ-ONLY; Identifier of the partner
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Name of the partner
	Name *string `json:"name,omitempty"`
	// PartnerProperties - Properties of the partner
	*PartnerProperties `json:"properties,omitempty"`
	// Type - READ-ONLY; Type of resource. "Microsoft.ManagementPartner/partners"
	Type *string `json:"type,omitempty"`
}

PartnerResponse this is the management partner operations response

func (PartnerResponse) MarshalJSON 

func (pr PartnerResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PartnerResponse.

func (*PartnerResponse) UnmarshalJSON 

func (pr *PartnerResponse) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PartnerResponse struct.

type PartnersClient 

type PartnersClient struct {
	BaseClient
}

PartnersClient is the this API describe ACE Provisioning ManagementPartner

func NewPartnersClient 

func NewPartnersClient() PartnersClient

NewPartnersClient creates an instance of the PartnersClient client.

func NewPartnersClientWithBaseURI 

func NewPartnersClientWithBaseURI(baseURI string) PartnersClient

NewPartnersClientWithBaseURI creates an instance of the PartnersClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (PartnersClient) Get 

func (client PartnersClient) Get(ctx context.Context) (result PartnerResponse, err error)

Get get the management partner using the objectId and tenantId.

func (PartnersClient) GetPreparer 

func (client PartnersClient) GetPreparer(ctx context.Context) (*http.Request, error)

GetPreparer prepares the Get request.

func (PartnersClient) GetResponder 

func (client PartnersClient) GetResponder(resp *http.Response) (result PartnerResponse, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (PartnersClient) GetSender 

func (client PartnersClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

type State 

type State string

State enumerates the values for state. 

const (
	// Active ...
	Active State = "Active"
	// Deleted ...
	Deleted State = "Deleted"
)

func PossibleStateValues 

func PossibleStateValues() []State

PossibleStateValues returns an array of possible values for the State const type.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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