iotdpsresource

package
v0.20240123.1162016 Latest Latest
Warning

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

Go to latest
Published: Jan 23, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/deviceprovisioningservices/2022-12-12/iotdpsresource Documentation

The iotdpsresource SDK allows for interaction with the Azure Resource Manager Service deviceprovisioningservices (API Version 2022-12-12).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/deviceprovisioningservices/2022-12-12/iotdpsresource"

Client Initialization

client := iotdpsresource.NewIotDpsResourceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: IotDpsResourceClient.CheckProvisioningServiceNameAvailability

ctx := context.TODO()
id := iotdpsresource.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

payload := iotdpsresource.OperationInputs{
	// ...
}


read, err := client.CheckProvisioningServiceNameAvailability(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: IotDpsResourceClient.CreateOrUpdate

ctx := context.TODO()
id := iotdpsresource.NewProvisioningServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceValue")

payload := iotdpsresource.ProvisioningServiceDescription{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: IotDpsResourceClient.CreateOrUpdatePrivateEndpointConnection

ctx := context.TODO()
id := iotdpsresource.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceValue", "privateEndpointConnectionValue")

payload := iotdpsresource.PrivateEndpointConnection{
	// ...
}


if err := client.CreateOrUpdatePrivateEndpointConnectionThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: IotDpsResourceClient.Delete

ctx := context.TODO()
id := iotdpsresource.NewProvisioningServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: IotDpsResourceClient.DeletePrivateEndpointConnection

ctx := context.TODO()
id := iotdpsresource.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceValue", "privateEndpointConnectionValue")

if err := client.DeletePrivateEndpointConnectionThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: IotDpsResourceClient.Get

ctx := context.TODO()
id := iotdpsresource.NewProvisioningServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceValue")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: IotDpsResourceClient.GetPrivateEndpointConnection

ctx := context.TODO()
id := iotdpsresource.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceValue", "privateEndpointConnectionValue")

read, err := client.GetPrivateEndpointConnection(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: IotDpsResourceClient.GetPrivateLinkResources

ctx := context.TODO()
id := iotdpsresource.NewPrivateLinkResourceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceValue", "groupIdValue")

read, err := client.GetPrivateLinkResources(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: IotDpsResourceClient.ListByResourceGroup

ctx := context.TODO()
id := iotdpsresource.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

// alternatively `client.ListByResourceGroup(ctx, id)` can be used to do batched pagination
items, err := client.ListByResourceGroupComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: IotDpsResourceClient.ListBySubscription

ctx := context.TODO()
id := iotdpsresource.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.ListBySubscription(ctx, id)` can be used to do batched pagination
items, err := client.ListBySubscriptionComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: IotDpsResourceClient.ListKeys

ctx := context.TODO()
id := iotdpsresource.NewProvisioningServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceValue")

// alternatively `client.ListKeys(ctx, id)` can be used to do batched pagination
items, err := client.ListKeysComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: IotDpsResourceClient.ListKeysForKeyName

ctx := context.TODO()
id := iotdpsresource.NewKeyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceValue", "keyValue")

read, err := client.ListKeysForKeyName(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: IotDpsResourceClient.ListPrivateEndpointConnections

ctx := context.TODO()
id := iotdpsresource.NewProvisioningServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceValue")

read, err := client.ListPrivateEndpointConnections(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: IotDpsResourceClient.ListPrivateLinkResources

ctx := context.TODO()
id := iotdpsresource.NewProvisioningServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceValue")

read, err := client.ListPrivateLinkResources(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: IotDpsResourceClient.ListValidSkus

ctx := context.TODO()
id := iotdpsresource.NewProvisioningServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceValue")

// alternatively `client.ListValidSkus(ctx, id)` can be used to do batched pagination
items, err := client.ListValidSkusComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: IotDpsResourceClient.Update

ctx := context.TODO()
id := iotdpsresource.NewProvisioningServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "provisioningServiceValue")

payload := iotdpsresource.TagsResource{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAccessRightsDescription

func PossibleValuesForAccessRightsDescription() []string

func PossibleValuesForAllocationPolicy

func PossibleValuesForAllocationPolicy() []string

func PossibleValuesForIPFilterActionType

func PossibleValuesForIPFilterActionType() []string

func PossibleValuesForIPFilterTargetType

func PossibleValuesForIPFilterTargetType() []string

func PossibleValuesForIotDpsSku

func PossibleValuesForIotDpsSku() []string

func PossibleValuesForNameUnavailabilityReason

func PossibleValuesForNameUnavailabilityReason() []string

func PossibleValuesForPrivateLinkServiceConnectionStatus

func PossibleValuesForPrivateLinkServiceConnectionStatus() []string

func PossibleValuesForPublicNetworkAccess

func PossibleValuesForPublicNetworkAccess() []string

func PossibleValuesForState

func PossibleValuesForState() []string

func ValidateKeyID

func ValidateKeyID(input interface{}, key string) (warnings []string, errors []error)

ValidateKeyID checks that 'input' can be parsed as a Key ID

func ValidatePrivateEndpointConnectionID

func ValidatePrivateEndpointConnectionID(input interface{}, key string) (warnings []string, errors []error)

ValidatePrivateEndpointConnectionID checks that 'input' can be parsed as a Private Endpoint Connection ID

func ValidatePrivateLinkResourceID

func ValidatePrivateLinkResourceID(input interface{}, key string) (warnings []string, errors []error)

ValidatePrivateLinkResourceID checks that 'input' can be parsed as a Private Link Resource ID

Types

type AccessRightsDescription

type AccessRightsDescription string
const (
	AccessRightsDescriptionDeviceConnect           AccessRightsDescription = "DeviceConnect"
	AccessRightsDescriptionEnrollmentRead          AccessRightsDescription = "EnrollmentRead"
	AccessRightsDescriptionEnrollmentWrite         AccessRightsDescription = "EnrollmentWrite"
	AccessRightsDescriptionRegistrationStatusRead  AccessRightsDescription = "RegistrationStatusRead"
	AccessRightsDescriptionRegistrationStatusWrite AccessRightsDescription = "RegistrationStatusWrite"
	AccessRightsDescriptionServiceConfig           AccessRightsDescription = "ServiceConfig"
)

func (*AccessRightsDescription) UnmarshalJSON added in v0.20230725.1205316

func (s *AccessRightsDescription) UnmarshalJSON(bytes []byte) error

type AllocationPolicy

type AllocationPolicy string
const (
	AllocationPolicyGeoLatency AllocationPolicy = "GeoLatency"
	AllocationPolicyHashed     AllocationPolicy = "Hashed"
	AllocationPolicyStatic     AllocationPolicy = "Static"
)

func (*AllocationPolicy) UnmarshalJSON added in v0.20230725.1205316

func (s *AllocationPolicy) UnmarshalJSON(bytes []byte) error

type CheckProvisioningServiceNameAvailabilityOperationResponse

type CheckProvisioningServiceNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NameAvailabilityInfo
}

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ProvisioningServiceDescription
}

type CreateOrUpdatePrivateEndpointConnectionOperationResponse

type CreateOrUpdatePrivateEndpointConnectionOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateEndpointConnection
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DeletePrivateEndpointConnectionOperationResponse

type DeletePrivateEndpointConnectionOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateEndpointConnection
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ProvisioningServiceDescription
}

type GetPrivateEndpointConnectionOperationResponse

type GetPrivateEndpointConnectionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateEndpointConnection
}

type GetPrivateLinkResourcesOperationResponse

type GetPrivateLinkResourcesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GroupIdInformation
}

type GroupIdInformation

type GroupIdInformation struct {
	Id         *string                      `json:"id,omitempty"`
	Name       *string                      `json:"name,omitempty"`
	Properties GroupIdInformationProperties `json:"properties"`
	Type       *string                      `json:"type,omitempty"`
}

type GroupIdInformationProperties

type GroupIdInformationProperties struct {
	GroupId           *string   `json:"groupId,omitempty"`
	RequiredMembers   *[]string `json:"requiredMembers,omitempty"`
	RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}

type IPFilterActionType

type IPFilterActionType string
const (
	IPFilterActionTypeAccept IPFilterActionType = "Accept"
	IPFilterActionTypeReject IPFilterActionType = "Reject"
)

func (*IPFilterActionType) UnmarshalJSON added in v0.20230725.1205316

func (s *IPFilterActionType) UnmarshalJSON(bytes []byte) error

type IPFilterRule

type IPFilterRule struct {
	Action     IPFilterActionType  `json:"action"`
	FilterName string              `json:"filterName"`
	IPMask     string              `json:"ipMask"`
	Target     *IPFilterTargetType `json:"target,omitempty"`
}

type IPFilterTargetType

type IPFilterTargetType string
const (
	IPFilterTargetTypeAll        IPFilterTargetType = "all"
	IPFilterTargetTypeDeviceApi  IPFilterTargetType = "deviceApi"
	IPFilterTargetTypeServiceApi IPFilterTargetType = "serviceApi"
)

func (*IPFilterTargetType) UnmarshalJSON added in v0.20230725.1205316

func (s *IPFilterTargetType) UnmarshalJSON(bytes []byte) error

type IotDpsPropertiesDescription

type IotDpsPropertiesDescription struct {
	AllocationPolicy           *AllocationPolicy                                                `json:"allocationPolicy,omitempty"`
	AuthorizationPolicies      *[]SharedAccessSignatureAuthorizationRuleAccessRightsDescription `json:"authorizationPolicies,omitempty"`
	DeviceProvisioningHostName *string                                                          `json:"deviceProvisioningHostName,omitempty"`
	EnableDataResidency        *bool                                                            `json:"enableDataResidency,omitempty"`
	IPFilterRules              *[]IPFilterRule                                                  `json:"ipFilterRules,omitempty"`
	IdScope                    *string                                                          `json:"idScope,omitempty"`
	IotHubs                    *[]IotHubDefinitionDescription                                   `json:"iotHubs,omitempty"`
	PortalOperationsHostName   *string                                                          `json:"portalOperationsHostName,omitempty"`
	PrivateEndpointConnections *[]PrivateEndpointConnection                                     `json:"privateEndpointConnections,omitempty"`
	ProvisioningState          *string                                                          `json:"provisioningState,omitempty"`
	PublicNetworkAccess        *PublicNetworkAccess                                             `json:"publicNetworkAccess,omitempty"`
	ServiceOperationsHostName  *string                                                          `json:"serviceOperationsHostName,omitempty"`
	State                      *State                                                           `json:"state,omitempty"`
}

type IotDpsResourceClient

type IotDpsResourceClient struct {
	Client *resourcemanager.Client
}

func NewIotDpsResourceClientWithBaseURI

func NewIotDpsResourceClientWithBaseURI(sdkApi sdkEnv.Api) (*IotDpsResourceClient, error)

func (IotDpsResourceClient) CheckProvisioningServiceNameAvailability

CheckProvisioningServiceNameAvailability ...

func (IotDpsResourceClient) CreateOrUpdate

CreateOrUpdate ...

func (IotDpsResourceClient) CreateOrUpdatePrivateEndpointConnection

CreateOrUpdatePrivateEndpointConnection ...

func (IotDpsResourceClient) CreateOrUpdatePrivateEndpointConnectionThenPoll

func (c IotDpsResourceClient) CreateOrUpdatePrivateEndpointConnectionThenPoll(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnection) error

CreateOrUpdatePrivateEndpointConnectionThenPoll performs CreateOrUpdatePrivateEndpointConnection then polls until it's completed

func (IotDpsResourceClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (IotDpsResourceClient) Delete

Delete ...

func (IotDpsResourceClient) DeletePrivateEndpointConnection

DeletePrivateEndpointConnection ...

func (IotDpsResourceClient) DeletePrivateEndpointConnectionThenPoll

func (c IotDpsResourceClient) DeletePrivateEndpointConnectionThenPoll(ctx context.Context, id PrivateEndpointConnectionId) error

DeletePrivateEndpointConnectionThenPoll performs DeletePrivateEndpointConnection then polls until it's completed

func (IotDpsResourceClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (IotDpsResourceClient) Get

Get ...

func (IotDpsResourceClient) GetPrivateEndpointConnection

GetPrivateEndpointConnection ...

func (IotDpsResourceClient) GetPrivateLinkResources

GetPrivateLinkResources ...

func (IotDpsResourceClient) ListByResourceGroup

ListByResourceGroup ...

func (IotDpsResourceClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (IotDpsResourceClient) ListByResourceGroupCompleteMatchingPredicate

func (c IotDpsResourceClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ProvisioningServiceDescriptionOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (IotDpsResourceClient) ListBySubscription

ListBySubscription ...

func (IotDpsResourceClient) ListBySubscriptionComplete

ListBySubscriptionComplete retrieves all the results into a single object

func (IotDpsResourceClient) ListBySubscriptionCompleteMatchingPredicate

func (c IotDpsResourceClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ProvisioningServiceDescriptionOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (IotDpsResourceClient) ListKeys

ListKeys ...

func (IotDpsResourceClient) ListKeysComplete

ListKeysComplete retrieves all the results into a single object

func (IotDpsResourceClient) ListKeysCompleteMatchingPredicate

ListKeysCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (IotDpsResourceClient) ListKeysForKeyName

func (c IotDpsResourceClient) ListKeysForKeyName(ctx context.Context, id KeyId) (result ListKeysForKeyNameOperationResponse, err error)

ListKeysForKeyName ...

func (IotDpsResourceClient) ListPrivateEndpointConnections

ListPrivateEndpointConnections ...

func (IotDpsResourceClient) ListPrivateLinkResources

ListPrivateLinkResources ...

func (IotDpsResourceClient) ListValidSkus

ListValidSkus ...

func (IotDpsResourceClient) ListValidSkusComplete

ListValidSkusComplete retrieves all the results into a single object

func (IotDpsResourceClient) ListValidSkusCompleteMatchingPredicate

func (c IotDpsResourceClient) ListValidSkusCompleteMatchingPredicate(ctx context.Context, id commonids.ProvisioningServiceId, predicate IotDpsSkuDefinitionOperationPredicate) (result ListValidSkusCompleteResult, err error)

ListValidSkusCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (IotDpsResourceClient) Update

Update ...

func (IotDpsResourceClient) UpdateThenPoll

UpdateThenPoll performs Update then polls until it's completed

type IotDpsSku

type IotDpsSku string
const (
	IotDpsSkuSOne IotDpsSku = "S1"
)

func (*IotDpsSku) UnmarshalJSON added in v0.20230725.1205316

func (s *IotDpsSku) UnmarshalJSON(bytes []byte) error

type IotDpsSkuDefinition

type IotDpsSkuDefinition struct {
	Name *IotDpsSku `json:"name,omitempty"`
}

type IotDpsSkuDefinitionOperationPredicate

type IotDpsSkuDefinitionOperationPredicate struct {
}

func (IotDpsSkuDefinitionOperationPredicate) Matches

type IotDpsSkuInfo

type IotDpsSkuInfo struct {
	Capacity *int64     `json:"capacity,omitempty"`
	Name     *IotDpsSku `json:"name,omitempty"`
	Tier     *string    `json:"tier,omitempty"`
}

type IotHubDefinitionDescription

type IotHubDefinitionDescription struct {
	AllocationWeight      *int64  `json:"allocationWeight,omitempty"`
	ApplyAllocationPolicy *bool   `json:"applyAllocationPolicy,omitempty"`
	ConnectionString      string  `json:"connectionString"`
	Location              string  `json:"location"`
	Name                  *string `json:"name,omitempty"`
}

type KeyId

type KeyId struct {
	SubscriptionId          string
	ResourceGroupName       string
	ProvisioningServiceName string
	KeyName                 string
}

KeyId is a struct representing the Resource ID for a Key

func NewKeyID

func NewKeyID(subscriptionId string, resourceGroupName string, provisioningServiceName string, keyName string) KeyId

NewKeyID returns a new KeyId struct

func ParseKeyID

func ParseKeyID(input string) (*KeyId, error)

ParseKeyID parses 'input' into a KeyId

func ParseKeyIDInsensitively

func ParseKeyIDInsensitively(input string) (*KeyId, error)

ParseKeyIDInsensitively parses 'input' case-insensitively into a KeyId note: this method should only be used for API response data and not user input

func (*KeyId) FromParseResult added in v0.20231127.1171502

func (id *KeyId) FromParseResult(input resourceids.ParseResult) error

func (KeyId) ID

func (id KeyId) ID() string

ID returns the formatted Key ID

func (KeyId) Segments

func (id KeyId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Key ID

func (KeyId) String

func (id KeyId) String() string

String returns a human-readable description of this Key ID

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ProvisioningServiceDescription
}

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ProvisioningServiceDescription
}

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ProvisioningServiceDescription
}

type ListBySubscriptionOperationResponse

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ProvisioningServiceDescription
}

type ListKeysCompleteResult

type ListKeysCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SharedAccessSignatureAuthorizationRuleAccessRightsDescription
}

type ListKeysForKeyNameOperationResponse

type ListKeysForKeyNameOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SharedAccessSignatureAuthorizationRuleAccessRightsDescription
}

type ListKeysOperationResponse

type ListKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SharedAccessSignatureAuthorizationRuleAccessRightsDescription
}

type ListPrivateEndpointConnectionsOperationResponse

type ListPrivateEndpointConnectionsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PrivateEndpointConnection
}

type ListPrivateLinkResourcesOperationResponse

type ListPrivateLinkResourcesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateLinkResources
}

type ListValidSkusCompleteResult

type ListValidSkusCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []IotDpsSkuDefinition
}

type ListValidSkusOperationResponse

type ListValidSkusOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]IotDpsSkuDefinition
}

type NameAvailabilityInfo

type NameAvailabilityInfo struct {
	Message       *string                   `json:"message,omitempty"`
	NameAvailable *bool                     `json:"nameAvailable,omitempty"`
	Reason        *NameUnavailabilityReason `json:"reason,omitempty"`
}

type NameUnavailabilityReason

type NameUnavailabilityReason string
const (
	NameUnavailabilityReasonAlreadyExists NameUnavailabilityReason = "AlreadyExists"
	NameUnavailabilityReasonInvalid       NameUnavailabilityReason = "Invalid"
)

func (*NameUnavailabilityReason) UnmarshalJSON added in v0.20230725.1205316

func (s *NameUnavailabilityReason) UnmarshalJSON(bytes []byte) error

type OperationInputs

type OperationInputs struct {
	Name string `json:"name"`
}

type PrivateEndpoint

type PrivateEndpoint struct {
	Id *string `json:"id,omitempty"`
}

type PrivateEndpointConnection

type PrivateEndpointConnection struct {
	Id         *string                             `json:"id,omitempty"`
	Name       *string                             `json:"name,omitempty"`
	Properties PrivateEndpointConnectionProperties `json:"properties"`
	SystemData *systemdata.SystemData              `json:"systemData,omitempty"`
	Type       *string                             `json:"type,omitempty"`
}

type PrivateEndpointConnectionId

type PrivateEndpointConnectionId struct {
	SubscriptionId                string
	ResourceGroupName             string
	ProvisioningServiceName       string
	PrivateEndpointConnectionName string
}

PrivateEndpointConnectionId is a struct representing the Resource ID for a Private Endpoint Connection

func NewPrivateEndpointConnectionID

func NewPrivateEndpointConnectionID(subscriptionId string, resourceGroupName string, provisioningServiceName string, privateEndpointConnectionName string) PrivateEndpointConnectionId

NewPrivateEndpointConnectionID returns a new PrivateEndpointConnectionId struct

func ParsePrivateEndpointConnectionID

func ParsePrivateEndpointConnectionID(input string) (*PrivateEndpointConnectionId, error)

ParsePrivateEndpointConnectionID parses 'input' into a PrivateEndpointConnectionId

func ParsePrivateEndpointConnectionIDInsensitively

func ParsePrivateEndpointConnectionIDInsensitively(input string) (*PrivateEndpointConnectionId, error)

ParsePrivateEndpointConnectionIDInsensitively parses 'input' case-insensitively into a PrivateEndpointConnectionId note: this method should only be used for API response data and not user input

func (*PrivateEndpointConnectionId) FromParseResult added in v0.20231127.1171502

func (id *PrivateEndpointConnectionId) FromParseResult(input resourceids.ParseResult) error

func (PrivateEndpointConnectionId) ID

ID returns the formatted Private Endpoint Connection ID

func (PrivateEndpointConnectionId) Segments

Segments returns a slice of Resource ID Segments which comprise this Private Endpoint Connection ID

func (PrivateEndpointConnectionId) String

func (id PrivateEndpointConnectionId) String() string

String returns a human-readable description of this Private Endpoint Connection ID

type PrivateEndpointConnectionProperties

type PrivateEndpointConnectionProperties struct {
	PrivateEndpoint                   *PrivateEndpoint                  `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState"`
}

type PrivateLinkResourceId

type PrivateLinkResourceId struct {
	SubscriptionId          string
	ResourceGroupName       string
	ProvisioningServiceName string
	GroupId                 string
}

PrivateLinkResourceId is a struct representing the Resource ID for a Private Link Resource

func NewPrivateLinkResourceID

func NewPrivateLinkResourceID(subscriptionId string, resourceGroupName string, provisioningServiceName string, groupId string) PrivateLinkResourceId

NewPrivateLinkResourceID returns a new PrivateLinkResourceId struct

func ParsePrivateLinkResourceID

func ParsePrivateLinkResourceID(input string) (*PrivateLinkResourceId, error)

ParsePrivateLinkResourceID parses 'input' into a PrivateLinkResourceId

func ParsePrivateLinkResourceIDInsensitively

func ParsePrivateLinkResourceIDInsensitively(input string) (*PrivateLinkResourceId, error)

ParsePrivateLinkResourceIDInsensitively parses 'input' case-insensitively into a PrivateLinkResourceId note: this method should only be used for API response data and not user input

func (*PrivateLinkResourceId) FromParseResult added in v0.20231127.1171502

func (id *PrivateLinkResourceId) FromParseResult(input resourceids.ParseResult) error

func (PrivateLinkResourceId) ID

func (id PrivateLinkResourceId) ID() string

ID returns the formatted Private Link Resource ID

func (PrivateLinkResourceId) Segments

func (id PrivateLinkResourceId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Private Link Resource ID

func (PrivateLinkResourceId) String

func (id PrivateLinkResourceId) String() string

String returns a human-readable description of this Private Link Resource ID

type PrivateLinkResources

type PrivateLinkResources struct {
	Value *[]GroupIdInformation `json:"value,omitempty"`
}

type PrivateLinkServiceConnectionState

type PrivateLinkServiceConnectionState struct {
	ActionsRequired *string                            `json:"actionsRequired,omitempty"`
	Description     string                             `json:"description"`
	Status          PrivateLinkServiceConnectionStatus `json:"status"`
}

type PrivateLinkServiceConnectionStatus

type PrivateLinkServiceConnectionStatus string
const (
	PrivateLinkServiceConnectionStatusApproved     PrivateLinkServiceConnectionStatus = "Approved"
	PrivateLinkServiceConnectionStatusDisconnected PrivateLinkServiceConnectionStatus = "Disconnected"
	PrivateLinkServiceConnectionStatusPending      PrivateLinkServiceConnectionStatus = "Pending"
	PrivateLinkServiceConnectionStatusRejected     PrivateLinkServiceConnectionStatus = "Rejected"
)

func (*PrivateLinkServiceConnectionStatus) UnmarshalJSON added in v0.20230725.1205316

func (s *PrivateLinkServiceConnectionStatus) UnmarshalJSON(bytes []byte) error

type ProvisioningServiceDescription

type ProvisioningServiceDescription struct {
	Etag           *string                     `json:"etag,omitempty"`
	Id             *string                     `json:"id,omitempty"`
	Location       string                      `json:"location"`
	Name           *string                     `json:"name,omitempty"`
	Properties     IotDpsPropertiesDescription `json:"properties"`
	Resourcegroup  *string                     `json:"resourcegroup,omitempty"`
	Sku            IotDpsSkuInfo               `json:"sku"`
	Subscriptionid *string                     `json:"subscriptionid,omitempty"`
	SystemData     *systemdata.SystemData      `json:"systemData,omitempty"`
	Tags           *map[string]string          `json:"tags,omitempty"`
	Type           *string                     `json:"type,omitempty"`
}

type ProvisioningServiceDescriptionOperationPredicate

type ProvisioningServiceDescriptionOperationPredicate struct {
	Etag           *string
	Id             *string
	Location       *string
	Name           *string
	Resourcegroup  *string
	Subscriptionid *string
	Type           *string
}

func (ProvisioningServiceDescriptionOperationPredicate) Matches

type PublicNetworkAccess

type PublicNetworkAccess string
const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

func (*PublicNetworkAccess) UnmarshalJSON added in v0.20230725.1205316

func (s *PublicNetworkAccess) UnmarshalJSON(bytes []byte) error

type SharedAccessSignatureAuthorizationRuleAccessRightsDescription

type SharedAccessSignatureAuthorizationRuleAccessRightsDescription struct {
	KeyName      string                  `json:"keyName"`
	PrimaryKey   *string                 `json:"primaryKey,omitempty"`
	Rights       AccessRightsDescription `json:"rights"`
	SecondaryKey *string                 `json:"secondaryKey,omitempty"`
}

type SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionOperationPredicate

type SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionOperationPredicate struct {
	KeyName      *string
	PrimaryKey   *string
	SecondaryKey *string
}

func (SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionOperationPredicate) Matches

type State

type State string
const (
	StateActivating       State = "Activating"
	StateActivationFailed State = "ActivationFailed"
	StateActive           State = "Active"
	StateDeleted          State = "Deleted"
	StateDeleting         State = "Deleting"
	StateDeletionFailed   State = "DeletionFailed"
	StateFailingOver      State = "FailingOver"
	StateFailoverFailed   State = "FailoverFailed"
	StateResuming         State = "Resuming"
	StateSuspended        State = "Suspended"
	StateSuspending       State = "Suspending"
	StateTransitioning    State = "Transitioning"
)

func (*State) UnmarshalJSON added in v0.20230725.1205316

func (s *State) UnmarshalJSON(bytes []byte) error

type TagsResource

type TagsResource struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type UpdateOperationResponse

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ProvisioningServiceDescription
}

Jump to

Keyboard shortcuts

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