apimanagementservice

package
v0.20231016.1155426 Latest Latest
Warning

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

Go to latest
Published: Oct 16, 2023 License: MPL-2.0 Imports: 17 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2023-03-01-preview/apimanagementservice Documentation

The apimanagementservice SDK allows for interaction with the Azure Resource Manager Service apimanagement (API Version 2023-03-01-preview).

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/apimanagement/2023-03-01-preview/apimanagementservice"

Client Initialization

client := apimanagementservice.NewApiManagementServiceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApiManagementServiceClient.ApplyNetworkConfigurationUpdates

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

payload := apimanagementservice.ApiManagementServiceApplyNetworkConfigurationParameters{
	// ...
}


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

Example Usage: ApiManagementServiceClient.Backup

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

payload := apimanagementservice.ApiManagementServiceBackupRestoreParameters{
	// ...
}


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

Example Usage: ApiManagementServiceClient.CheckNameAvailability

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

payload := apimanagementservice.ApiManagementServiceCheckNameAvailabilityParameters{
	// ...
}


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

Example Usage: ApiManagementServiceClient.CreateOrUpdate

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

payload := apimanagementservice.ApiManagementServiceResource{
	// ...
}


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

Example Usage: ApiManagementServiceClient.Delete

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

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

Example Usage: ApiManagementServiceClient.Get

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

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: ApiManagementServiceClient.GetDomainOwnershipIdentifier

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

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

Example Usage: ApiManagementServiceClient.GetSsoToken

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

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

Example Usage: ApiManagementServiceClient.List

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

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

Example Usage: ApiManagementServiceClient.ListByResourceGroup

ctx := context.TODO()
id := apimanagementservice.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: ApiManagementServiceClient.MigrateToStv2

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

payload := apimanagementservice.MigrateToStv2Contract{
	// ...
}


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

Example Usage: ApiManagementServiceClient.Restore

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

payload := apimanagementservice.ApiManagementServiceBackupRestoreParameters{
	// ...
}


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

Example Usage: ApiManagementServiceClient.Update

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

payload := apimanagementservice.ApiManagementServiceUpdateParameters{
	// ...
}


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 PossibleValuesForAccessType

func PossibleValuesForAccessType() []string

func PossibleValuesForCertificateSource

func PossibleValuesForCertificateSource() []string

func PossibleValuesForCertificateStatus

func PossibleValuesForCertificateStatus() []string

func PossibleValuesForDeveloperPortalStatus

func PossibleValuesForDeveloperPortalStatus() []string

func PossibleValuesForHostnameType

func PossibleValuesForHostnameType() []string

func PossibleValuesForLegacyApiState

func PossibleValuesForLegacyApiState() []string

func PossibleValuesForLegacyPortalStatus

func PossibleValuesForLegacyPortalStatus() []string

func PossibleValuesForMigrateToStv2Mode

func PossibleValuesForMigrateToStv2Mode() []string

func PossibleValuesForNameAvailabilityReason

func PossibleValuesForNameAvailabilityReason() []string

func PossibleValuesForNatGatewayState

func PossibleValuesForNatGatewayState() []string

func PossibleValuesForPlatformVersion

func PossibleValuesForPlatformVersion() []string

func PossibleValuesForPrivateEndpointServiceConnectionStatus

func PossibleValuesForPrivateEndpointServiceConnectionStatus() []string

func PossibleValuesForPublicNetworkAccess

func PossibleValuesForPublicNetworkAccess() []string

func PossibleValuesForSkuType

func PossibleValuesForSkuType() []string

func PossibleValuesForStoreName

func PossibleValuesForStoreName() []string

func PossibleValuesForVirtualNetworkType

func PossibleValuesForVirtualNetworkType() []string

func ValidateServiceID

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

ValidateServiceID checks that 'input' can be parsed as a Service ID

Types

type AccessType

type AccessType string
const (
	AccessTypeAccessKey                     AccessType = "AccessKey"
	AccessTypeSystemAssignedManagedIdentity AccessType = "SystemAssignedManagedIdentity"
	AccessTypeUserAssignedManagedIdentity   AccessType = "UserAssignedManagedIdentity"
)

func (*AccessType) UnmarshalJSON

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

type AdditionalLocation

type AdditionalLocation struct {
	DisableGateway              *bool                             `json:"disableGateway,omitempty"`
	GatewayRegionalUrl          *string                           `json:"gatewayRegionalUrl,omitempty"`
	Location                    string                            `json:"location"`
	NatGatewayState             *NatGatewayState                  `json:"natGatewayState,omitempty"`
	OutboundPublicIPAddresses   *[]string                         `json:"outboundPublicIPAddresses,omitempty"`
	PlatformVersion             *PlatformVersion                  `json:"platformVersion,omitempty"`
	PrivateIPAddresses          *[]string                         `json:"privateIPAddresses,omitempty"`
	PublicIPAddressId           *string                           `json:"publicIpAddressId,omitempty"`
	PublicIPAddresses           *[]string                         `json:"publicIPAddresses,omitempty"`
	Sku                         ApiManagementServiceSkuProperties `json:"sku"`
	VirtualNetworkConfiguration *VirtualNetworkConfiguration      `json:"virtualNetworkConfiguration,omitempty"`
	Zones                       *zones.Schema                     `json:"zones,omitempty"`
}

type ApiManagementServiceApplyNetworkConfigurationParameters

type ApiManagementServiceApplyNetworkConfigurationParameters struct {
	Location *string `json:"location,omitempty"`
}

type ApiManagementServiceBackupRestoreParameters

type ApiManagementServiceBackupRestoreParameters struct {
	AccessKey      *string     `json:"accessKey,omitempty"`
	AccessType     *AccessType `json:"accessType,omitempty"`
	BackupName     string      `json:"backupName"`
	ClientId       *string     `json:"clientId,omitempty"`
	ContainerName  string      `json:"containerName"`
	StorageAccount string      `json:"storageAccount"`
}

type ApiManagementServiceCheckNameAvailabilityParameters

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

type ApiManagementServiceClient

type ApiManagementServiceClient struct {
	Client *resourcemanager.Client
}

func NewApiManagementServiceClientWithBaseURI

func NewApiManagementServiceClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiManagementServiceClient, error)

func (ApiManagementServiceClient) ApplyNetworkConfigurationUpdates

ApplyNetworkConfigurationUpdates ...

func (ApiManagementServiceClient) ApplyNetworkConfigurationUpdatesThenPoll

func (c ApiManagementServiceClient) ApplyNetworkConfigurationUpdatesThenPoll(ctx context.Context, id ServiceId, input ApiManagementServiceApplyNetworkConfigurationParameters) error

ApplyNetworkConfigurationUpdatesThenPoll performs ApplyNetworkConfigurationUpdates then polls until it's completed

func (ApiManagementServiceClient) Backup

Backup ...

func (ApiManagementServiceClient) BackupThenPoll

BackupThenPoll performs Backup then polls until it's completed

func (ApiManagementServiceClient) CheckNameAvailability

CheckNameAvailability ...

func (ApiManagementServiceClient) CreateOrUpdate

CreateOrUpdate ...

func (ApiManagementServiceClient) CreateOrUpdateThenPoll

func (c ApiManagementServiceClient) CreateOrUpdateThenPoll(ctx context.Context, id ServiceId, input ApiManagementServiceResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ApiManagementServiceClient) Delete

Delete ...

func (ApiManagementServiceClient) DeleteThenPoll

func (c ApiManagementServiceClient) DeleteThenPoll(ctx context.Context, id ServiceId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ApiManagementServiceClient) Get

Get ...

func (ApiManagementServiceClient) GetDomainOwnershipIdentifier

GetDomainOwnershipIdentifier ...

func (ApiManagementServiceClient) GetSsoToken

GetSsoToken ...

func (ApiManagementServiceClient) List

List ...

func (ApiManagementServiceClient) ListByResourceGroup

ListByResourceGroup ...

func (ApiManagementServiceClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (ApiManagementServiceClient) ListByResourceGroupCompleteMatchingPredicate

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ApiManagementServiceClient) ListComplete

ListComplete retrieves all the results into a single object

func (ApiManagementServiceClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ApiManagementServiceClient) MigrateToStv2

MigrateToStv2 ...

func (ApiManagementServiceClient) MigrateToStv2ThenPoll

func (c ApiManagementServiceClient) MigrateToStv2ThenPoll(ctx context.Context, id ServiceId, input MigrateToStv2Contract) error

MigrateToStv2ThenPoll performs MigrateToStv2 then polls until it's completed

func (ApiManagementServiceClient) Restore

Restore ...

func (ApiManagementServiceClient) RestoreThenPoll

RestoreThenPoll performs Restore then polls until it's completed

func (ApiManagementServiceClient) Update

Update ...

func (ApiManagementServiceClient) UpdateThenPoll

UpdateThenPoll performs Update then polls until it's completed

type ApiManagementServiceGetDomainOwnershipIdentifierResult

type ApiManagementServiceGetDomainOwnershipIdentifierResult struct {
	DomainOwnershipIdentifier *string `json:"domainOwnershipIdentifier,omitempty"`
}

type ApiManagementServiceGetSsoTokenResult

type ApiManagementServiceGetSsoTokenResult struct {
	RedirectUri *string `json:"redirectUri,omitempty"`
}

type ApiManagementServiceNameAvailabilityResult

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

type ApiManagementServiceProperties

type ApiManagementServiceProperties struct {
	AdditionalLocations         *[]AdditionalLocation                     `json:"additionalLocations,omitempty"`
	ApiVersionConstraint        *ApiVersionConstraint                     `json:"apiVersionConstraint,omitempty"`
	Certificates                *[]CertificateConfiguration               `json:"certificates,omitempty"`
	ConfigurationApi            *ConfigurationApi                         `json:"configurationApi,omitempty"`
	CreatedAtUtc                *string                                   `json:"createdAtUtc,omitempty"`
	CustomProperties            *map[string]string                        `json:"customProperties,omitempty"`
	DeveloperPortalStatus       *DeveloperPortalStatus                    `json:"developerPortalStatus,omitempty"`
	DeveloperPortalUrl          *string                                   `json:"developerPortalUrl,omitempty"`
	DisableGateway              *bool                                     `json:"disableGateway,omitempty"`
	EnableClientCertificate     *bool                                     `json:"enableClientCertificate,omitempty"`
	GatewayRegionalUrl          *string                                   `json:"gatewayRegionalUrl,omitempty"`
	GatewayUrl                  *string                                   `json:"gatewayUrl,omitempty"`
	HostnameConfigurations      *[]HostnameConfiguration                  `json:"hostnameConfigurations,omitempty"`
	LegacyPortalStatus          *LegacyPortalStatus                       `json:"legacyPortalStatus,omitempty"`
	ManagementApiUrl            *string                                   `json:"managementApiUrl,omitempty"`
	NatGatewayState             *NatGatewayState                          `json:"natGatewayState,omitempty"`
	NotificationSenderEmail     *string                                   `json:"notificationSenderEmail,omitempty"`
	OutboundPublicIPAddresses   *[]string                                 `json:"outboundPublicIPAddresses,omitempty"`
	PlatformVersion             *PlatformVersion                          `json:"platformVersion,omitempty"`
	PortalUrl                   *string                                   `json:"portalUrl,omitempty"`
	PrivateEndpointConnections  *[]RemotePrivateEndpointConnectionWrapper `json:"privateEndpointConnections,omitempty"`
	PrivateIPAddresses          *[]string                                 `json:"privateIPAddresses,omitempty"`
	ProvisioningState           *string                                   `json:"provisioningState,omitempty"`
	PublicIPAddressId           *string                                   `json:"publicIpAddressId,omitempty"`
	PublicIPAddresses           *[]string                                 `json:"publicIPAddresses,omitempty"`
	PublicNetworkAccess         *PublicNetworkAccess                      `json:"publicNetworkAccess,omitempty"`
	PublisherEmail              string                                    `json:"publisherEmail"`
	PublisherName               string                                    `json:"publisherName"`
	Restore                     *bool                                     `json:"restore,omitempty"`
	ScmUrl                      *string                                   `json:"scmUrl,omitempty"`
	TargetProvisioningState     *string                                   `json:"targetProvisioningState,omitempty"`
	VirtualNetworkConfiguration *VirtualNetworkConfiguration              `json:"virtualNetworkConfiguration,omitempty"`
	VirtualNetworkType          *VirtualNetworkType                       `json:"virtualNetworkType,omitempty"`
}

func (*ApiManagementServiceProperties) GetCreatedAtUtcAsTime

func (o *ApiManagementServiceProperties) GetCreatedAtUtcAsTime() (*time.Time, error)

func (*ApiManagementServiceProperties) SetCreatedAtUtcAsTime

func (o *ApiManagementServiceProperties) SetCreatedAtUtcAsTime(input time.Time)

type ApiManagementServiceResource

type ApiManagementServiceResource struct {
	Etag       *string                            `json:"etag,omitempty"`
	Id         *string                            `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   string                             `json:"location"`
	Name       *string                            `json:"name,omitempty"`
	Properties ApiManagementServiceProperties     `json:"properties"`
	Sku        ApiManagementServiceSkuProperties  `json:"sku"`
	SystemData *systemdata.SystemData             `json:"systemData,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,omitempty"`
	Zones      *zones.Schema                      `json:"zones,omitempty"`
}

type ApiManagementServiceResourceOperationPredicate

type ApiManagementServiceResourceOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ApiManagementServiceResourceOperationPredicate) Matches

type ApiManagementServiceSkuProperties

type ApiManagementServiceSkuProperties struct {
	Capacity int64   `json:"capacity"`
	Name     SkuType `json:"name"`
}

type ApiManagementServiceUpdateParameters

type ApiManagementServiceUpdateParameters struct {
	Etag       *string                               `json:"etag,omitempty"`
	Id         *string                               `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap    `json:"identity,omitempty"`
	Name       *string                               `json:"name,omitempty"`
	Properties *ApiManagementServiceUpdateProperties `json:"properties,omitempty"`
	Sku        *ApiManagementServiceSkuProperties    `json:"sku,omitempty"`
	Tags       *map[string]string                    `json:"tags,omitempty"`
	Type       *string                               `json:"type,omitempty"`
	Zones      *zones.Schema                         `json:"zones,omitempty"`
}

type ApiManagementServiceUpdateProperties

type ApiManagementServiceUpdateProperties struct {
	AdditionalLocations         *[]AdditionalLocation                     `json:"additionalLocations,omitempty"`
	ApiVersionConstraint        *ApiVersionConstraint                     `json:"apiVersionConstraint,omitempty"`
	Certificates                *[]CertificateConfiguration               `json:"certificates,omitempty"`
	ConfigurationApi            *ConfigurationApi                         `json:"configurationApi,omitempty"`
	CreatedAtUtc                *string                                   `json:"createdAtUtc,omitempty"`
	CustomProperties            *map[string]string                        `json:"customProperties,omitempty"`
	DeveloperPortalStatus       *DeveloperPortalStatus                    `json:"developerPortalStatus,omitempty"`
	DeveloperPortalUrl          *string                                   `json:"developerPortalUrl,omitempty"`
	DisableGateway              *bool                                     `json:"disableGateway,omitempty"`
	EnableClientCertificate     *bool                                     `json:"enableClientCertificate,omitempty"`
	GatewayRegionalUrl          *string                                   `json:"gatewayRegionalUrl,omitempty"`
	GatewayUrl                  *string                                   `json:"gatewayUrl,omitempty"`
	HostnameConfigurations      *[]HostnameConfiguration                  `json:"hostnameConfigurations,omitempty"`
	LegacyPortalStatus          *LegacyPortalStatus                       `json:"legacyPortalStatus,omitempty"`
	ManagementApiUrl            *string                                   `json:"managementApiUrl,omitempty"`
	NatGatewayState             *NatGatewayState                          `json:"natGatewayState,omitempty"`
	NotificationSenderEmail     *string                                   `json:"notificationSenderEmail,omitempty"`
	OutboundPublicIPAddresses   *[]string                                 `json:"outboundPublicIPAddresses,omitempty"`
	PlatformVersion             *PlatformVersion                          `json:"platformVersion,omitempty"`
	PortalUrl                   *string                                   `json:"portalUrl,omitempty"`
	PrivateEndpointConnections  *[]RemotePrivateEndpointConnectionWrapper `json:"privateEndpointConnections,omitempty"`
	PrivateIPAddresses          *[]string                                 `json:"privateIPAddresses,omitempty"`
	ProvisioningState           *string                                   `json:"provisioningState,omitempty"`
	PublicIPAddressId           *string                                   `json:"publicIpAddressId,omitempty"`
	PublicIPAddresses           *[]string                                 `json:"publicIPAddresses,omitempty"`
	PublicNetworkAccess         *PublicNetworkAccess                      `json:"publicNetworkAccess,omitempty"`
	PublisherEmail              *string                                   `json:"publisherEmail,omitempty"`
	PublisherName               *string                                   `json:"publisherName,omitempty"`
	Restore                     *bool                                     `json:"restore,omitempty"`
	ScmUrl                      *string                                   `json:"scmUrl,omitempty"`
	TargetProvisioningState     *string                                   `json:"targetProvisioningState,omitempty"`
	VirtualNetworkConfiguration *VirtualNetworkConfiguration              `json:"virtualNetworkConfiguration,omitempty"`
	VirtualNetworkType          *VirtualNetworkType                       `json:"virtualNetworkType,omitempty"`
}

func (*ApiManagementServiceUpdateProperties) GetCreatedAtUtcAsTime

func (o *ApiManagementServiceUpdateProperties) GetCreatedAtUtcAsTime() (*time.Time, error)

func (*ApiManagementServiceUpdateProperties) SetCreatedAtUtcAsTime

func (o *ApiManagementServiceUpdateProperties) SetCreatedAtUtcAsTime(input time.Time)

type ApiVersionConstraint

type ApiVersionConstraint struct {
	MinApiVersion *string `json:"minApiVersion,omitempty"`
}

type ApplyNetworkConfigurationUpdatesOperationResponse

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

type ArmIdWrapper

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

type BackupOperationResponse

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

type CertificateConfiguration

type CertificateConfiguration struct {
	Certificate         *CertificateInformation `json:"certificate,omitempty"`
	CertificatePassword *string                 `json:"certificatePassword,omitempty"`
	EncodedCertificate  *string                 `json:"encodedCertificate,omitempty"`
	StoreName           StoreName               `json:"storeName"`
}

type CertificateInformation

type CertificateInformation struct {
	Expiry     string `json:"expiry"`
	Subject    string `json:"subject"`
	Thumbprint string `json:"thumbprint"`
}

func (*CertificateInformation) GetExpiryAsTime

func (o *CertificateInformation) GetExpiryAsTime() (*time.Time, error)

func (*CertificateInformation) SetExpiryAsTime

func (o *CertificateInformation) SetExpiryAsTime(input time.Time)

type CertificateSource

type CertificateSource string
const (
	CertificateSourceBuiltIn  CertificateSource = "BuiltIn"
	CertificateSourceCustom   CertificateSource = "Custom"
	CertificateSourceKeyVault CertificateSource = "KeyVault"
	CertificateSourceManaged  CertificateSource = "Managed"
)

func (*CertificateSource) UnmarshalJSON

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

type CertificateStatus

type CertificateStatus string
const (
	CertificateStatusCompleted  CertificateStatus = "Completed"
	CertificateStatusFailed     CertificateStatus = "Failed"
	CertificateStatusInProgress CertificateStatus = "InProgress"
)

func (*CertificateStatus) UnmarshalJSON

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

type CheckNameAvailabilityOperationResponse

type CheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApiManagementServiceNameAvailabilityResult
}

type ConfigurationApi

type ConfigurationApi struct {
	LegacyApi *LegacyApiState `json:"legacyApi,omitempty"`
}

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type DeveloperPortalStatus

type DeveloperPortalStatus string
const (
	DeveloperPortalStatusDisabled DeveloperPortalStatus = "Disabled"
	DeveloperPortalStatusEnabled  DeveloperPortalStatus = "Enabled"
)

func (*DeveloperPortalStatus) UnmarshalJSON

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

type GetDomainOwnershipIdentifierOperationResponse

type GetDomainOwnershipIdentifierOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApiManagementServiceGetDomainOwnershipIdentifierResult
}

type GetOperationResponse

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

type GetSsoTokenOperationResponse

type GetSsoTokenOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApiManagementServiceGetSsoTokenResult
}

type HostnameConfiguration

type HostnameConfiguration struct {
	Certificate                *CertificateInformation `json:"certificate,omitempty"`
	CertificatePassword        *string                 `json:"certificatePassword,omitempty"`
	CertificateSource          *CertificateSource      `json:"certificateSource,omitempty"`
	CertificateStatus          *CertificateStatus      `json:"certificateStatus,omitempty"`
	DefaultSslBinding          *bool                   `json:"defaultSslBinding,omitempty"`
	EncodedCertificate         *string                 `json:"encodedCertificate,omitempty"`
	HostName                   string                  `json:"hostName"`
	IdentityClientId           *string                 `json:"identityClientId,omitempty"`
	KeyVaultId                 *string                 `json:"keyVaultId,omitempty"`
	NegotiateClientCertificate *bool                   `json:"negotiateClientCertificate,omitempty"`
	Type                       HostnameType            `json:"type"`
}

type HostnameType

type HostnameType string
const (
	HostnameTypeConfigurationApi HostnameType = "ConfigurationApi"
	HostnameTypeDeveloperPortal  HostnameType = "DeveloperPortal"
	HostnameTypeManagement       HostnameType = "Management"
	HostnameTypePortal           HostnameType = "Portal"
	HostnameTypeProxy            HostnameType = "Proxy"
	HostnameTypeScm              HostnameType = "Scm"
)

func (*HostnameType) UnmarshalJSON

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

type LegacyApiState

type LegacyApiState string
const (
	LegacyApiStateDisabled LegacyApiState = "Disabled"
	LegacyApiStateEnabled  LegacyApiState = "Enabled"
)

func (*LegacyApiState) UnmarshalJSON

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

type LegacyPortalStatus

type LegacyPortalStatus string
const (
	LegacyPortalStatusDisabled LegacyPortalStatus = "Disabled"
	LegacyPortalStatusEnabled  LegacyPortalStatus = "Enabled"
)

func (*LegacyPortalStatus) UnmarshalJSON

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

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	Items []ApiManagementServiceResource
}

type ListByResourceGroupOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	Items []ApiManagementServiceResource
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApiManagementServiceResource
}

type MigrateToStv2Contract

type MigrateToStv2Contract struct {
	Mode *MigrateToStv2Mode `json:"mode,omitempty"`
}

type MigrateToStv2Mode

type MigrateToStv2Mode string
const (
	MigrateToStv2ModeNewIP      MigrateToStv2Mode = "NewIP"
	MigrateToStv2ModePreserveIP MigrateToStv2Mode = "PreserveIp"
)

func (*MigrateToStv2Mode) UnmarshalJSON

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

type MigrateToStv2OperationResponse

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

type NameAvailabilityReason

type NameAvailabilityReason string
const (
	NameAvailabilityReasonAlreadyExists NameAvailabilityReason = "AlreadyExists"
	NameAvailabilityReasonInvalid       NameAvailabilityReason = "Invalid"
	NameAvailabilityReasonValid         NameAvailabilityReason = "Valid"
)

func (*NameAvailabilityReason) UnmarshalJSON

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

type NatGatewayState

type NatGatewayState string
const (
	NatGatewayStateDisabled NatGatewayState = "Disabled"
	NatGatewayStateEnabled  NatGatewayState = "Enabled"
)

func (*NatGatewayState) UnmarshalJSON

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

type PlatformVersion

type PlatformVersion string
const (
	PlatformVersionMtvOne         PlatformVersion = "mtv1"
	PlatformVersionStvOne         PlatformVersion = "stv1"
	PlatformVersionStvTwo         PlatformVersion = "stv2"
	PlatformVersionStvTwoPointOne PlatformVersion = "stv2.1"
	PlatformVersionUndetermined   PlatformVersion = "undetermined"
)

func (*PlatformVersion) UnmarshalJSON

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

type PrivateEndpointConnectionWrapperProperties

type PrivateEndpointConnectionWrapperProperties struct {
	GroupIds                          *[]string                         `json:"groupIds,omitempty"`
	PrivateEndpoint                   *ArmIdWrapper                     `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState"`
	ProvisioningState                 *string                           `json:"provisioningState,omitempty"`
}

type PrivateEndpointServiceConnectionStatus

type PrivateEndpointServiceConnectionStatus string
const (
	PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved"
	PrivateEndpointServiceConnectionStatusPending  PrivateEndpointServiceConnectionStatus = "Pending"
	PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected"
)

func (*PrivateEndpointServiceConnectionStatus) UnmarshalJSON

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

type PrivateLinkServiceConnectionState

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

type PublicNetworkAccess

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

func (*PublicNetworkAccess) UnmarshalJSON

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

type RemotePrivateEndpointConnectionWrapper

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

type RestoreOperationResponse

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

type ServiceId

type ServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
}

ServiceId is a struct representing the Resource ID for a Service

func NewServiceID

func NewServiceID(subscriptionId string, resourceGroupName string, serviceName string) ServiceId

NewServiceID returns a new ServiceId struct

func ParseServiceID

func ParseServiceID(input string) (*ServiceId, error)

ParseServiceID parses 'input' into a ServiceId

func ParseServiceIDInsensitively

func ParseServiceIDInsensitively(input string) (*ServiceId, error)

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

func (ServiceId) ID

func (id ServiceId) ID() string

ID returns the formatted Service ID

func (ServiceId) Segments

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

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

func (ServiceId) String

func (id ServiceId) String() string

String returns a human-readable description of this Service ID

type SkuType

type SkuType string
const (
	SkuTypeBasic       SkuType = "Basic"
	SkuTypeConsumption SkuType = "Consumption"
	SkuTypeDeveloper   SkuType = "Developer"
	SkuTypeIsolated    SkuType = "Isolated"
	SkuTypePremium     SkuType = "Premium"
	SkuTypeStandard    SkuType = "Standard"
)

func (*SkuType) UnmarshalJSON

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

type StoreName

type StoreName string
const (
	StoreNameCertificateAuthority StoreName = "CertificateAuthority"
	StoreNameRoot                 StoreName = "Root"
)

func (*StoreName) UnmarshalJSON

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

type UpdateOperationResponse

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

type VirtualNetworkConfiguration

type VirtualNetworkConfiguration struct {
	SubnetResourceId *string `json:"subnetResourceId,omitempty"`
	Subnetname       *string `json:"subnetname,omitempty"`
	Vnetid           *string `json:"vnetid,omitempty"`
}

type VirtualNetworkType

type VirtualNetworkType string
const (
	VirtualNetworkTypeExternal VirtualNetworkType = "External"
	VirtualNetworkTypeInternal VirtualNetworkType = "Internal"
	VirtualNetworkTypeNone     VirtualNetworkType = "None"
)

func (*VirtualNetworkType) UnmarshalJSON

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

Jump to

Keyboard shortcuts

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