Documentation ¶
Index ¶
- type APISClient
- func (client *APISClient) BeginManageInventoryMetadata(ctx context.Context, familyIdentifier string, location string, ...) (*runtime.Poller[APISClientManageInventoryMetadataResponse], error)
- func (client *APISClient) ManageLink(ctx context.Context, familyIdentifier string, location string, ...) (APISClientManageLinkResponse, error)
- func (client *APISClient) NewListOperationsPartnerPager(options *APISClientListOperationsPartnerOptions) *runtime.Pager[APISClientListOperationsPartnerResponse]
- func (client *APISClient) NewSearchInventoriesPager(searchInventoriesRequest SearchInventoriesRequest, ...) *runtime.Pager[APISClientSearchInventoriesResponse]
- type APISClientBeginManageInventoryMetadataOptions
- type APISClientListOperationsPartnerOptions
- type APISClientListOperationsPartnerResponse
- type APISClientManageInventoryMetadataResponse
- type APISClientManageLinkOptions
- type APISClientManageLinkResponse
- type APISClientSearchInventoriesOptions
- type APISClientSearchInventoriesResponse
- type ActionType
- type AdditionalErrorInfo
- type AdditionalInventoryDetails
- type AdditionalOrderItemDetails
- type BillingDetails
- type ClientFactory
- type ConfigurationData
- type ConfigurationDetails
- type ConfigurationOnDevice
- type ErrorAdditionalInfo
- type ErrorDetail
- type ErrorResponse
- type InventoryAdditionalDetails
- type InventoryData
- type InventoryProperties
- type ManageInventoryMetadataRequest
- type ManageLinkOperation
- type ManageLinkRequest
- type ManagementResourceData
- type Operation
- type OperationDisplay
- type OperationListResult
- type OrderItemData
- type OrderItemType
- type Origin
- type PartnerInventory
- type PartnerInventoryList
- type SearchInventoriesRequest
- type SpecificationDetails
- type StageDetails
- type StageName
- type StageStatus
- type SubscriptionDetails
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APISClient ¶ added in v0.2.0
type APISClient struct {
// contains filtered or unexported fields
}
APISClient contains the methods for the EdgeOrderPartnerAPIS group. Don't use this type directly, use NewAPISClient() instead.
func NewAPISClient ¶ added in v0.2.0
func NewAPISClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*APISClient, error)
NewAPISClient creates a new instance of APISClient with the specified values.
- subscriptionID - The ID of the target subscription.
- credential - used to authorize requests. Usually a credential from azidentity.
- options - pass nil to accept the default values.
func (*APISClient) BeginManageInventoryMetadata ¶ added in v0.2.0
func (client *APISClient) BeginManageInventoryMetadata(ctx context.Context, familyIdentifier string, location string, serialNumber string, manageInventoryMetadataRequest ManageInventoryMetadataRequest, options *APISClientBeginManageInventoryMetadataOptions) (*runtime.Poller[APISClientManageInventoryMetadataResponse], error)
BeginManageInventoryMetadata - API for updating inventory metadata and inventory configuration If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2020-12-01-preview
- familyIdentifier - Unique identifier for the product family
- location - The location of the resource
- serialNumber - The serial number of the device
- manageInventoryMetadataRequest - Updates inventory metadata and inventory configuration
- options - APISClientBeginManageInventoryMetadataOptions contains the optional parameters for the APISClient.BeginManageInventoryMetadata method.
Example ¶
Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageInventoryMetadata.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/edgeorderpartner/armedgeorderpartner" ) func main() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { log.Fatalf("failed to obtain a credential: %v", err) } ctx := context.Background() clientFactory, err := armedgeorderpartner.NewClientFactory("<subscription-id>", cred, nil) if err != nil { log.Fatalf("failed to create client: %v", err) } poller, err := clientFactory.NewAPISClient().BeginManageInventoryMetadata(ctx, "AzureStackEdge", "westus", "SerialNumber1", armedgeorderpartner.ManageInventoryMetadataRequest{ ConfigurationOnDevice: &armedgeorderpartner.ConfigurationOnDevice{ ConfigurationIdentifier: to.Ptr("EdgeP_High"), }, InventoryMetadata: to.Ptr("InventoryMetadata"), }, 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 (*APISClient) ManageLink ¶ added in v0.2.0
func (client *APISClient) ManageLink(ctx context.Context, familyIdentifier string, location string, serialNumber string, manageLinkRequest ManageLinkRequest, options *APISClientManageLinkOptions) (APISClientManageLinkResponse, error)
ManageLink - API for linking management resource with inventory If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2020-12-01-preview
- familyIdentifier - Unique identifier for the product family
- location - The location of the resource
- serialNumber - The serial number of the device
- manageLinkRequest - Links the management resource to the inventory
- options - APISClientManageLinkOptions contains the optional parameters for the APISClient.ManageLink method.
Example ¶
Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ManageLink.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/edgeorderpartner/armedgeorderpartner" ) func main() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { log.Fatalf("failed to obtain a credential: %v", err) } ctx := context.Background() clientFactory, err := armedgeorderpartner.NewClientFactory("<subscription-id>", cred, nil) if err != nil { log.Fatalf("failed to create client: %v", err) } _, err = clientFactory.NewAPISClient().ManageLink(ctx, "AzureStackEdge", "westus", "SerialNumber1", armedgeorderpartner.ManageLinkRequest{ ManagementResourceArmID: to.Ptr("/subscriptions/c783ea86-c85c-4175-b76d-3992656af50d/resourceGroups/EdgeTestRG/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/TestEdgeDeviceName1"), Operation: to.Ptr(armedgeorderpartner.ManageLinkOperationLink), TenantID: to.Ptr("a783ea86-c85c-4175-b76d-3992656af50d"), }, nil) if err != nil { log.Fatalf("failed to finish the request: %v", err) } }
Output:
func (*APISClient) NewListOperationsPartnerPager ¶ added in v0.4.0
func (client *APISClient) NewListOperationsPartnerPager(options *APISClientListOperationsPartnerOptions) *runtime.Pager[APISClientListOperationsPartnerResponse]
NewListOperationsPartnerPager - This method gets all the operations that are exposed for customer.
Generated from API version 2020-12-01-preview
- options - APISClientListOperationsPartnerOptions contains the optional parameters for the APISClient.NewListOperationsPartnerPager method.
Example ¶
Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/ListOperationsPartner.json
package main import ( "context" "log" "github.com/Azure/azure-sdk-for-go/sdk/azidentity" "github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/edgeorderpartner/armedgeorderpartner" ) func main() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { log.Fatalf("failed to obtain a credential: %v", err) } ctx := context.Background() clientFactory, err := armedgeorderpartner.NewClientFactory("<subscription-id>", cred, nil) if err != nil { log.Fatalf("failed to create client: %v", err) } pager := clientFactory.NewAPISClient().NewListOperationsPartnerPager(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.OperationListResult = armedgeorderpartner.OperationListResult{ // Value: []*armedgeorderpartner.Operation{ // { // Name: to.Ptr("Microsoft.EdgeOrderPartner/operations/read"), // Display: &armedgeorderpartner.OperationDisplay{ // Description: to.Ptr("List or get the Operations"), // Operation: to.Ptr("List or Get Operations"), // Provider: to.Ptr("Edge Ordering"), // Resource: to.Ptr("Operations"), // }, // IsDataAction: to.Ptr(false), // Origin: to.Ptr(armedgeorderpartner.OriginUser), // }, // { // Name: to.Ptr("Microsoft.EdgeOrderPartner/searchInventories/action"), // Display: &armedgeorderpartner.OperationDisplay{ // Provider: to.Ptr("Edge Ordering"), // Resource: to.Ptr("ArmApiRes_Microsoft.EdgeOrderPartner"), // }, // IsDataAction: to.Ptr(true), // Origin: to.Ptr(armedgeorderpartner.OriginUser), // }, // { // Name: to.Ptr("Microsoft.EdgeOrderPartner/locations/productFamilies/inventories/manageLink/action"), // Display: &armedgeorderpartner.OperationDisplay{ // Provider: to.Ptr("Edge Ordering"), // Resource: to.Ptr("ArmApiRes_inventories"), // }, // IsDataAction: to.Ptr(true), // Origin: to.Ptr(armedgeorderpartner.OriginUser), // }, // { // Name: to.Ptr("Microsoft.EdgeOrderPartner/locations/productFamilies/inventories/manageInventoryMetadata/action"), // Display: &armedgeorderpartner.OperationDisplay{ // Provider: to.Ptr("Edge Ordering"), // Resource: to.Ptr("ArmApiRes_inventories"), // }, // IsDataAction: to.Ptr(true), // Origin: to.Ptr(armedgeorderpartner.OriginUser), // }}, // } } }
Output:
func (*APISClient) NewSearchInventoriesPager ¶ added in v0.4.0
func (client *APISClient) NewSearchInventoriesPager(searchInventoriesRequest SearchInventoriesRequest, options *APISClientSearchInventoriesOptions) *runtime.Pager[APISClientSearchInventoriesResponse]
NewSearchInventoriesPager - API for Search inventories
Generated from API version 2020-12-01-preview
- searchInventoriesRequest - Searches inventories with the given filters and returns in the form of a list
- options - APISClientSearchInventoriesOptions contains the optional parameters for the APISClient.NewSearchInventoriesPager method.
Example (SearchInventories) ¶
Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventories.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/edgeorderpartner/armedgeorderpartner" ) func main() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { log.Fatalf("failed to obtain a credential: %v", err) } ctx := context.Background() clientFactory, err := armedgeorderpartner.NewClientFactory("<subscription-id>", cred, nil) if err != nil { log.Fatalf("failed to create client: %v", err) } pager := clientFactory.NewAPISClient().NewSearchInventoriesPager(armedgeorderpartner.SearchInventoriesRequest{ FamilyIdentifier: to.Ptr("AzureStackEdge"), SerialNumber: to.Ptr("SerialNumber1"), }, 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.PartnerInventoryList = armedgeorderpartner.PartnerInventoryList{ // Value: []*armedgeorderpartner.PartnerInventory{ // { // Properties: &armedgeorderpartner.InventoryProperties{ // Configuration: &armedgeorderpartner.ConfigurationData{ // ConfigurationIdentifier: to.Ptr("EdgeP_Base"), // ConfigurationIdentifierOnDevice: to.Ptr("EdgeP_High"), // FamilyIdentifier: to.Ptr("AzureStackEdge"), // ProductIdentifier: to.Ptr("AzureStackEdgeProGPU"), // ProductLineIdentifier: to.Ptr("AzureStackEdgePL"), // }, // Inventory: &armedgeorderpartner.InventoryData{ // Location: to.Ptr("Rack"), // RegistrationAllowed: to.Ptr(true), // Status: to.Ptr("Healthy"), // }, // Location: to.Ptr("westus"), // ManagementResource: &armedgeorderpartner.ManagementResourceData{ // ArmID: to.Ptr("/subscriptions/c783ea86-c85c-4175-b76d-3992656af50d/resourceGroups/EdgeTestRG/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/TestEdgeDeviceName1"), // TenantID: to.Ptr("a783ea86-c85c-4175-b76d-3992656af50d"), // }, // OrderItem: &armedgeorderpartner.OrderItemData{ // ArmID: to.Ptr("/subscriptions/b783ea86-c85c-4175-b76d-3992656af50d/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orders/TestOrderName1"), // OrderItemType: to.Ptr(armedgeorderpartner.OrderItemTypeRental), // }, // SerialNumber: to.Ptr("SerialNumber1"), // }, // }}, // } } }
Output:
Example (SearchInventoriesDetails) ¶
Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/edgeorderpartner/resource-manager/Microsoft.EdgeOrderPartner/preview/2020-12-01-preview/examples/SearchInventoriesDetails.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/edgeorderpartner/armedgeorderpartner" ) func main() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { log.Fatalf("failed to obtain a credential: %v", err) } ctx := context.Background() clientFactory, err := armedgeorderpartner.NewClientFactory("<subscription-id>", cred, nil) if err != nil { log.Fatalf("failed to create client: %v", err) } pager := clientFactory.NewAPISClient().NewSearchInventoriesPager(armedgeorderpartner.SearchInventoriesRequest{ FamilyIdentifier: to.Ptr("AzureStackEdge"), SerialNumber: to.Ptr("SerialNumber1"), }, 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.PartnerInventoryList = armedgeorderpartner.PartnerInventoryList{ // Value: []*armedgeorderpartner.PartnerInventory{ // { // Properties: &armedgeorderpartner.InventoryProperties{ // Configuration: &armedgeorderpartner.ConfigurationData{ // ConfigurationIdentifier: to.Ptr("EdgeP_Base"), // ConfigurationIdentifierOnDevice: to.Ptr("EdgeP_High"), // FamilyIdentifier: to.Ptr("AzureStackEdge"), // ProductIdentifier: to.Ptr("AzureStackEdgeProGPU"), // ProductLineIdentifier: to.Ptr("AzureStackEdgePL"), // }, // Inventory: &armedgeorderpartner.InventoryData{ // Location: to.Ptr("Rack"), // RegistrationAllowed: to.Ptr(true), // Status: to.Ptr("Healthy"), // }, // Location: to.Ptr("westus"), // ManagementResource: &armedgeorderpartner.ManagementResourceData{ // ArmID: to.Ptr("/subscriptions/c783ea86-c85c-4175-b76d-3992656af50d/resourceGroups/EdgeTestRG/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/TestEdgeDeviceName1"), // TenantID: to.Ptr("a783ea86-c85c-4175-b76d-3992656af50d"), // }, // OrderItem: &armedgeorderpartner.OrderItemData{ // ArmID: to.Ptr("/subscriptions/b783ea86-c85c-4175-b76d-3992656af50d/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orders/TestOrderName1"), // OrderItemType: to.Ptr(armedgeorderpartner.OrderItemTypeRental), // }, // SerialNumber: to.Ptr("SerialNumber1"), // Details: &armedgeorderpartner.InventoryAdditionalDetails{ // Billing: &armedgeorderpartner.BillingDetails{ // BillingType: to.Ptr("Pav2"), // Status: to.Ptr("InProgress"), // }, // Configuration: &armedgeorderpartner.ConfigurationDetails{ // Specifications: []*armedgeorderpartner.SpecificationDetails{ // { // Name: to.Ptr("Cores"), // Value: to.Ptr("24"), // }, // { // Name: to.Ptr("Memory"), // Value: to.Ptr("128 GB"), // }, // { // Name: to.Ptr("Storage"), // Value: to.Ptr("~8 TB"), // }}, // }, // Inventory: &armedgeorderpartner.AdditionalInventoryDetails{ // AdditionalData: map[string]*string{ // "ManuacturingYear": to.Ptr("2020"), // "SourceCountry": to.Ptr("USA"), // }, // }, // InventoryMetadata: to.Ptr("This is currently in Japan"), // InventorySecrets: map[string]*string{ // "PublicCert": to.Ptr("<PublicCert>"), // }, // OrderItem: &armedgeorderpartner.AdditionalOrderItemDetails{ // Status: &armedgeorderpartner.StageDetails{ // DisplayName: to.Ptr("Delivered - Succeeded"), // StageName: to.Ptr(armedgeorderpartner.StageNameDelivered), // StageStatus: to.Ptr(armedgeorderpartner.StageStatusSucceeded), // StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-07T05:20:36.334Z"); return t}()), // }, // Subscription: &armedgeorderpartner.SubscriptionDetails{ // ID: to.Ptr("b783ea86-c85c-4175-b76d-3992656af50d"), // QuotaID: to.Ptr("Internal_2014-09-01"), // State: to.Ptr("Registered"), // }, // }, // }, // }, // }}, // } } }
Output:
type APISClientBeginManageInventoryMetadataOptions ¶ added in v0.2.0
type APISClientBeginManageInventoryMetadataOptions struct { // Resumes the LRO from the provided token. ResumeToken string }
APISClientBeginManageInventoryMetadataOptions contains the optional parameters for the APISClient.BeginManageInventoryMetadata method.
type APISClientListOperationsPartnerOptions ¶ added in v0.2.0
type APISClientListOperationsPartnerOptions struct { }
APISClientListOperationsPartnerOptions contains the optional parameters for the APISClient.NewListOperationsPartnerPager method.
type APISClientListOperationsPartnerResponse ¶ added in v0.2.0
type APISClientListOperationsPartnerResponse struct { // A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. OperationListResult }
APISClientListOperationsPartnerResponse contains the response from method APISClient.NewListOperationsPartnerPager.
type APISClientManageInventoryMetadataResponse ¶ added in v0.2.0
type APISClientManageInventoryMetadataResponse struct { }
APISClientManageInventoryMetadataResponse contains the response from method APISClient.BeginManageInventoryMetadata.
type APISClientManageLinkOptions ¶ added in v0.2.0
type APISClientManageLinkOptions struct { }
APISClientManageLinkOptions contains the optional parameters for the APISClient.ManageLink method.
type APISClientManageLinkResponse ¶ added in v0.2.0
type APISClientManageLinkResponse struct { }
APISClientManageLinkResponse contains the response from method APISClient.ManageLink.
type APISClientSearchInventoriesOptions ¶ added in v0.2.0
type APISClientSearchInventoriesOptions struct { }
APISClientSearchInventoriesOptions contains the optional parameters for the APISClient.NewSearchInventoriesPager method.
type APISClientSearchInventoriesResponse ¶ added in v0.2.0
type APISClientSearchInventoriesResponse struct { // Represents the list of partner inventories PartnerInventoryList }
APISClientSearchInventoriesResponse contains the response from method APISClient.NewSearchInventoriesPager.
type ActionType ¶
type ActionType string
ActionType - Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
const (
ActionTypeInternal ActionType = "Internal"
)
func PossibleActionTypeValues ¶
func PossibleActionTypeValues() []ActionType
PossibleActionTypeValues returns the possible values for the ActionType const type.
type AdditionalErrorInfo ¶
func (AdditionalErrorInfo) MarshalJSON ¶ added in v0.6.0
func (a AdditionalErrorInfo) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AdditionalErrorInfo.
func (*AdditionalErrorInfo) UnmarshalJSON ¶ added in v0.6.0
func (a *AdditionalErrorInfo) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AdditionalErrorInfo.
type AdditionalInventoryDetails ¶
type AdditionalInventoryDetails struct { // READ-ONLY; Additional Data AdditionalData map[string]*string }
AdditionalInventoryDetails - Contains additional data about inventory in dictionary format
func (AdditionalInventoryDetails) MarshalJSON ¶
func (a AdditionalInventoryDetails) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AdditionalInventoryDetails.
func (*AdditionalInventoryDetails) UnmarshalJSON ¶ added in v0.6.0
func (a *AdditionalInventoryDetails) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AdditionalInventoryDetails.
type AdditionalOrderItemDetails ¶
type AdditionalOrderItemDetails struct { // READ-ONLY; Order item status Status *StageDetails // READ-ONLY; Subscription details Subscription *SubscriptionDetails }
AdditionalOrderItemDetails - Contains additional order item details
func (AdditionalOrderItemDetails) MarshalJSON ¶ added in v0.6.0
func (a AdditionalOrderItemDetails) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AdditionalOrderItemDetails.
func (*AdditionalOrderItemDetails) UnmarshalJSON ¶ added in v0.6.0
func (a *AdditionalOrderItemDetails) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AdditionalOrderItemDetails.
type BillingDetails ¶
type BillingDetails struct { // READ-ONLY; Billing type for the inventory BillingType *string // READ-ONLY; Billing status for the inventory Status *string }
BillingDetails - Contains billing details for the inventory
func (BillingDetails) MarshalJSON ¶ added in v0.6.0
func (b BillingDetails) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type BillingDetails.
func (*BillingDetails) UnmarshalJSON ¶ added in v0.6.0
func (b *BillingDetails) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type BillingDetails.
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 ID of the target subscription.
- credential - used to authorize requests. Usually a credential from azidentity.
- options - pass nil to accept the default values.
func (*ClientFactory) NewAPISClient ¶ added in v0.6.0
func (c *ClientFactory) NewAPISClient() *APISClient
NewAPISClient creates a new instance of APISClient.
type ConfigurationData ¶
type ConfigurationData struct { // READ-ONLY; Configuration identifier of inventory ConfigurationIdentifier *string // READ-ONLY; Configuration identifier on device - this is used in case of any mismatch between actual configuration on inventory // and configuration stored in service ConfigurationIdentifierOnDevice *string // READ-ONLY; Family identifier of inventory FamilyIdentifier *string // READ-ONLY; Product identifier of inventory ProductIdentifier *string // READ-ONLY; Product Line identifier of inventory ProductLineIdentifier *string }
ConfigurationData - Contains information about inventory configuration
func (ConfigurationData) MarshalJSON ¶ added in v0.6.0
func (c ConfigurationData) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ConfigurationData.
func (*ConfigurationData) UnmarshalJSON ¶ added in v0.6.0
func (c *ConfigurationData) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationData.
type ConfigurationDetails ¶
type ConfigurationDetails struct { // READ-ONLY; Collection of specification details about the inventory Specifications []*SpecificationDetails }
ConfigurationDetails - Contains additional configuration details about inventory
func (ConfigurationDetails) MarshalJSON ¶
func (c ConfigurationDetails) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ConfigurationDetails.
func (*ConfigurationDetails) UnmarshalJSON ¶ added in v0.6.0
func (c *ConfigurationDetails) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationDetails.
type ConfigurationOnDevice ¶
type ConfigurationOnDevice struct { // REQUIRED; Configuration identifier on device ConfigurationIdentifier *string }
ConfigurationOnDevice - Configuration parameters for ManageInventoryMetadata call
func (ConfigurationOnDevice) MarshalJSON ¶ added in v0.6.0
func (c ConfigurationOnDevice) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ConfigurationOnDevice.
func (*ConfigurationOnDevice) UnmarshalJSON ¶ added in v0.6.0
func (c *ConfigurationOnDevice) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationOnDevice.
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 InventoryAdditionalDetails ¶
type InventoryAdditionalDetails struct { // Represents additional details about the order item OrderItem *AdditionalOrderItemDetails // READ-ONLY; Represents additional details about billing for the inventory Billing *BillingDetails // READ-ONLY; Represents additional details about the configuration Configuration *ConfigurationDetails // READ-ONLY; Represents additional data about the inventory Inventory *AdditionalInventoryDetails // READ-ONLY; Contains inventory metadata InventoryMetadata *string // READ-ONLY; Represents secrets on the inventory InventorySecrets map[string]*string }
InventoryAdditionalDetails - Represents additional details about the partner inventory
func (InventoryAdditionalDetails) MarshalJSON ¶
func (i InventoryAdditionalDetails) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type InventoryAdditionalDetails.
func (*InventoryAdditionalDetails) UnmarshalJSON ¶ added in v0.6.0
func (i *InventoryAdditionalDetails) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type InventoryAdditionalDetails.
type InventoryData ¶
type InventoryData struct { // READ-ONLY; Inventory location Location *string // READ-ONLY; Boolean flag to indicate if registration is allowed RegistrationAllowed *bool // READ-ONLY; Inventory status Status *string }
InventoryData - Contains basic information about inventory
func (InventoryData) MarshalJSON ¶ added in v0.6.0
func (i InventoryData) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type InventoryData.
func (*InventoryData) UnmarshalJSON ¶ added in v0.6.0
func (i *InventoryData) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type InventoryData.
type InventoryProperties ¶
type InventoryProperties struct { // READ-ONLY; Represents basic configuration data. Configuration *ConfigurationData // READ-ONLY; Represents additional details of inventory Details *InventoryAdditionalDetails // READ-ONLY; Represents basic inventory data. Inventory *InventoryData // READ-ONLY; Location of inventory Location *string // READ-ONLY; Represents management resource data associated with inventory. ManagementResource *ManagementResourceData // READ-ONLY; Represents basic order item data. OrderItem *OrderItemData // READ-ONLY; Serial number of the device. SerialNumber *string }
InventoryProperties - Represents inventory properties
func (InventoryProperties) MarshalJSON ¶ added in v0.6.0
func (i InventoryProperties) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type InventoryProperties.
func (*InventoryProperties) UnmarshalJSON ¶ added in v0.6.0
func (i *InventoryProperties) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type InventoryProperties.
type ManageInventoryMetadataRequest ¶
type ManageInventoryMetadataRequest struct { // REQUIRED; Inventory metadata to be updated InventoryMetadata *string // Inventory configuration to be updated ConfigurationOnDevice *ConfigurationOnDevice }
ManageInventoryMetadataRequest - Request body for ManageInventoryMetadata call
func (ManageInventoryMetadataRequest) MarshalJSON ¶ added in v0.6.0
func (m ManageInventoryMetadataRequest) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ManageInventoryMetadataRequest.
func (*ManageInventoryMetadataRequest) UnmarshalJSON ¶ added in v0.6.0
func (m *ManageInventoryMetadataRequest) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ManageInventoryMetadataRequest.
type ManageLinkOperation ¶
type ManageLinkOperation string
ManageLinkOperation - Operation to be performed - Link, Unlink, Relink
const ( // ManageLinkOperationLink - Link. ManageLinkOperationLink ManageLinkOperation = "Link" // ManageLinkOperationRelink - Relink. ManageLinkOperationRelink ManageLinkOperation = "Relink" // ManageLinkOperationUnlink - Unlink. ManageLinkOperationUnlink ManageLinkOperation = "Unlink" )
func PossibleManageLinkOperationValues ¶
func PossibleManageLinkOperationValues() []ManageLinkOperation
PossibleManageLinkOperationValues returns the possible values for the ManageLinkOperation const type.
type ManageLinkRequest ¶
type ManageLinkRequest struct { // REQUIRED; Arm Id of the management resource to which inventory is to be linked For unlink operation, enter empty string ManagementResourceArmID *string // REQUIRED; Operation to be performed - Link, Unlink, Relink Operation *ManageLinkOperation // REQUIRED; Tenant ID of management resource associated with inventory TenantID *string }
ManageLinkRequest - Request body for ManageLink call
func (ManageLinkRequest) MarshalJSON ¶ added in v0.6.0
func (m ManageLinkRequest) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ManageLinkRequest.
func (*ManageLinkRequest) UnmarshalJSON ¶ added in v0.6.0
func (m *ManageLinkRequest) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ManageLinkRequest.
type ManagementResourceData ¶
type ManagementResourceData struct { // READ-ONLY; Arm ID of management resource associated with inventory ArmID *string // READ-ONLY; Tenant ID of management resource associated with inventory TenantID *string }
ManagementResourceData - Contains information about management resource
func (ManagementResourceData) MarshalJSON ¶ added in v0.6.0
func (m ManagementResourceData) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ManagementResourceData.
func (*ManagementResourceData) UnmarshalJSON ¶ added in v0.6.0
func (m *ManagementResourceData) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ManagementResourceData.
type Operation ¶
type Operation struct { // Localized display information for this particular operation. Display *OperationDisplay // READ-ONLY; Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ActionType *ActionType // READ-ONLY; Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane // operations. IsDataAction *bool // READ-ONLY; The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", // "Microsoft.Compute/virtualMachines/capture/action" Name *string // READ-ONLY; The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default // value is "user,system" Origin *Origin }
Operation - Details of a REST API operation, returned from the Resource Provider Operations API
func (Operation) MarshalJSON ¶ added in v0.6.0
MarshalJSON implements the json.Marshaller interface for type Operation.
func (*Operation) UnmarshalJSON ¶ added in v0.6.0
UnmarshalJSON implements the json.Unmarshaller interface for type Operation.
type OperationDisplay ¶
type OperationDisplay struct { // READ-ONLY; The short, localized friendly description of the operation; suitable for tool tips and detailed views. Description *string // READ-ONLY; The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual // Machine", "Restart Virtual Machine". Operation *string // READ-ONLY; The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft // Compute". Provider *string // READ-ONLY; The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job // Schedule Collections". Resource *string }
OperationDisplay - Localized display information for this particular operation.
func (OperationDisplay) MarshalJSON ¶ added in v0.6.0
func (o OperationDisplay) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type OperationDisplay.
func (*OperationDisplay) UnmarshalJSON ¶ added in v0.6.0
func (o *OperationDisplay) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type OperationDisplay.
type OperationListResult ¶
type OperationListResult struct { // READ-ONLY; URL to get the next set of operation list results (if there are any). NextLink *string // READ-ONLY; List of operations supported by the resource provider Value []*Operation }
OperationListResult - A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
func (OperationListResult) MarshalJSON ¶
func (o OperationListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type OperationListResult.
func (*OperationListResult) UnmarshalJSON ¶ added in v0.6.0
func (o *OperationListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type OperationListResult.
type OrderItemData ¶
type OrderItemData struct { // READ-ONLY; Arm ID of order item ArmID *string // READ-ONLY; Order item type - purchase or rental OrderItemType *OrderItemType }
OrderItemData - Contains information about the order item to which inventory belongs
func (OrderItemData) MarshalJSON ¶ added in v0.6.0
func (o OrderItemData) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type OrderItemData.
func (*OrderItemData) UnmarshalJSON ¶ added in v0.6.0
func (o *OrderItemData) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type OrderItemData.
type OrderItemType ¶
type OrderItemType string
OrderItemType - Order item type - purchase or rental
const ( // OrderItemTypePurchase - Purchase OrderItem. OrderItemTypePurchase OrderItemType = "Purchase" // OrderItemTypeRental - Rental OrderItem. OrderItemTypeRental OrderItemType = "Rental" )
func PossibleOrderItemTypeValues ¶
func PossibleOrderItemTypeValues() []OrderItemType
PossibleOrderItemTypeValues returns the possible values for the OrderItemType const type.
type Origin ¶
type Origin string
Origin - The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
func PossibleOriginValues ¶
func PossibleOriginValues() []Origin
PossibleOriginValues returns the possible values for the Origin const type.
type PartnerInventory ¶
type PartnerInventory struct { // READ-ONLY; Inventory properties Properties *InventoryProperties }
PartnerInventory - Represents partner inventory contract
func (PartnerInventory) MarshalJSON ¶ added in v0.6.0
func (p PartnerInventory) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type PartnerInventory.
func (*PartnerInventory) UnmarshalJSON ¶ added in v0.6.0
func (p *PartnerInventory) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type PartnerInventory.
type PartnerInventoryList ¶
type PartnerInventoryList struct { // Link for the next set of partner inventories. NextLink *string // READ-ONLY; List of partner inventories Value []*PartnerInventory }
PartnerInventoryList - Represents the list of partner inventories
func (PartnerInventoryList) MarshalJSON ¶
func (p PartnerInventoryList) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type PartnerInventoryList.
func (*PartnerInventoryList) UnmarshalJSON ¶ added in v0.6.0
func (p *PartnerInventoryList) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type PartnerInventoryList.
type SearchInventoriesRequest ¶
type SearchInventoriesRequest struct { // REQUIRED; Family identifier for inventory FamilyIdentifier *string // REQUIRED; Serial number of the inventory SerialNumber *string }
SearchInventoriesRequest - Request body for SearchInventories call
func (SearchInventoriesRequest) MarshalJSON ¶ added in v0.6.0
func (s SearchInventoriesRequest) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type SearchInventoriesRequest.
func (*SearchInventoriesRequest) UnmarshalJSON ¶ added in v0.6.0
func (s *SearchInventoriesRequest) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type SearchInventoriesRequest.
type SpecificationDetails ¶
type SpecificationDetails struct { // READ-ONLY; Name of the specification property Name *string // READ-ONLY; Value of the specification property Value *string }
SpecificationDetails - Specification details for the inventory
func (SpecificationDetails) MarshalJSON ¶ added in v0.6.0
func (s SpecificationDetails) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type SpecificationDetails.
func (*SpecificationDetails) UnmarshalJSON ¶ added in v0.6.0
func (s *SpecificationDetails) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type SpecificationDetails.
type StageDetails ¶
type StageDetails struct { // READ-ONLY; Display name of the resource stage. DisplayName *string // READ-ONLY; Stage name StageName *StageName // READ-ONLY; Stage status. StageStatus *StageStatus // READ-ONLY; Stage start time StartTime *time.Time }
StageDetails - Resource stage details.
func (StageDetails) MarshalJSON ¶
func (s StageDetails) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type StageDetails.
func (*StageDetails) UnmarshalJSON ¶
func (s *StageDetails) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type StageDetails.
type StageName ¶
type StageName string
StageName - Stage name
const ( // StageNameAborted - Order has been aborted. StageNameAborted StageName = "Aborted" // StageNameAtAzureDC - Device has been received at Azure datacenter from the user. StageNameAtAzureDC StageName = "AtAzureDC" // StageNameCancelled - Order has been cancelled. StageNameCancelled StageName = "Cancelled" // StageNameCompleted - Order has completed. StageNameCompleted StageName = "Completed" // StageNameCompletedWithErrors - Order has completed with errors. StageNameCompletedWithErrors StageName = "CompletedWithErrors" // StageNameCompletedWithWarnings - Order has completed with warnings. StageNameCompletedWithWarnings StageName = "CompletedWithWarnings" // StageNameConfirmed - Order is confirmed StageNameConfirmed StageName = "Confirmed" StageNameCurrent StageName = "Current" // StageNameDataCopy - Data copy from the device at Azure datacenter. StageNameDataCopy StageName = "DataCopy" // StageNameDelivered - Order is delivered to customer StageNameDelivered StageName = "Delivered" // StageNameDeviceOrdered - An order has been created. StageNameDeviceOrdered StageName = "DeviceOrdered" // StageNameDevicePrepared - A device has been prepared for the order. StageNameDevicePrepared StageName = "DevicePrepared" // StageNameInReview - Order is currently in draft mode and can still be cancelled StageNameInReview StageName = "InReview" // StageNameInUse - Order is in use at customer site StageNameInUse StageName = "InUse" // StageNamePickedUp - Device has been picked up from user and in transit to Azure datacenter. StageNamePickedUp StageName = "PickedUp" // StageNamePlaced - Currently in draft mode and can still be cancelled StageNamePlaced StageName = "Placed" // StageNameReadyForDispatch - Order is ready for dispatch StageNameReadyForDispatch StageName = "ReadyForDispatch" // StageNameReadyToDispatchFromAzureDC - Device is ready to be handed to customer from Azure DC. StageNameReadyToDispatchFromAzureDC StageName = "ReadyToDispatchFromAzureDC" // StageNameReadyToReceiveAtAzureDC - Device can be dropped off at Azure DC. StageNameReadyToReceiveAtAzureDC StageName = "ReadyToReceiveAtAzureDC" // StageNameShipped - Order is in transit to customer StageNameShipped StageName = "Shipped" )
func PossibleStageNameValues ¶
func PossibleStageNameValues() []StageName
PossibleStageNameValues returns the possible values for the StageName const type.
type StageStatus ¶
type StageStatus string
StageStatus - Stage status.
const ( // StageStatusCancelled - Stage has been cancelled. StageStatusCancelled StageStatus = "Cancelled" // StageStatusCancelling - Stage is cancelling. StageStatusCancelling StageStatus = "Cancelling" // StageStatusFailed - Stage has failed. StageStatusFailed StageStatus = "Failed" // StageStatusInProgress - Stage is in progress. StageStatusInProgress StageStatus = "InProgress" // StageStatusNone - No status available yet. StageStatusNone StageStatus = "None" // StageStatusSucceeded - Stage has succeeded. StageStatusSucceeded StageStatus = "Succeeded" )
func PossibleStageStatusValues ¶
func PossibleStageStatusValues() []StageStatus
PossibleStageStatusValues returns the possible values for the StageStatus const type.
type SubscriptionDetails ¶
type SubscriptionDetails struct { // READ-ONLY; Subscription Id ID *string // READ-ONLY; Subscription QuotaId QuotaID *string // READ-ONLY; Subscription State State *string }
SubscriptionDetails - Contains subscription details
func (SubscriptionDetails) MarshalJSON ¶ added in v0.6.0
func (s SubscriptionDetails) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type SubscriptionDetails.
func (*SubscriptionDetails) UnmarshalJSON ¶ added in v0.6.0
func (s *SubscriptionDetails) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type SubscriptionDetails.