Documentation
¶
Index ¶
- type AccessKeys
- type AccessRights
- type ActionType
- type AuthorizationRule
- type AuthorizationRuleListResult
- type AuthorizationRuleProperties
- type CheckNameAvailability
- type CheckNameAvailabilityResult
- type ClientFactory
- func (c *ClientFactory) NewHybridConnectionsClient() *HybridConnectionsClient
- func (c *ClientFactory) NewNamespacesClient() *NamespacesClient
- func (c *ClientFactory) NewOperationsClient() *OperationsClient
- func (c *ClientFactory) NewPrivateEndpointConnectionsClient() *PrivateEndpointConnectionsClient
- func (c *ClientFactory) NewPrivateLinkResourcesClient() *PrivateLinkResourcesClient
- func (c *ClientFactory) NewWCFRelaysClient() *WCFRelaysClient
- type ConnectionState
- type CreatedByType
- type DefaultAction
- type EndPointProvisioningState
- type HybridConnection
- type HybridConnectionListResult
- type HybridConnectionProperties
- type HybridConnectionsClient
- func (client *HybridConnectionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, namespaceName string, ...) (HybridConnectionsClientCreateOrUpdateResponse, error)
- func (client *HybridConnectionsClient) CreateOrUpdateAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, ...) (HybridConnectionsClientCreateOrUpdateAuthorizationRuleResponse, error)
- func (client *HybridConnectionsClient) Delete(ctx context.Context, resourceGroupName string, namespaceName string, ...) (HybridConnectionsClientDeleteResponse, error)
- func (client *HybridConnectionsClient) DeleteAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, ...) (HybridConnectionsClientDeleteAuthorizationRuleResponse, error)
- func (client *HybridConnectionsClient) Get(ctx context.Context, resourceGroupName string, namespaceName string, ...) (HybridConnectionsClientGetResponse, error)
- func (client *HybridConnectionsClient) GetAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, ...) (HybridConnectionsClientGetAuthorizationRuleResponse, error)
- func (client *HybridConnectionsClient) ListKeys(ctx context.Context, resourceGroupName string, namespaceName string, ...) (HybridConnectionsClientListKeysResponse, error)
- func (client *HybridConnectionsClient) NewListAuthorizationRulesPager(resourceGroupName string, namespaceName string, hybridConnectionName string, ...) *runtime.Pager[HybridConnectionsClientListAuthorizationRulesResponse]
- func (client *HybridConnectionsClient) NewListByNamespacePager(resourceGroupName string, namespaceName string, ...) *runtime.Pager[HybridConnectionsClientListByNamespaceResponse]
- func (client *HybridConnectionsClient) RegenerateKeys(ctx context.Context, resourceGroupName string, namespaceName string, ...) (HybridConnectionsClientRegenerateKeysResponse, error)
- type HybridConnectionsClientCreateOrUpdateAuthorizationRuleOptions
- type HybridConnectionsClientCreateOrUpdateAuthorizationRuleResponse
- type HybridConnectionsClientCreateOrUpdateOptions
- type HybridConnectionsClientCreateOrUpdateResponse
- type HybridConnectionsClientDeleteAuthorizationRuleOptions
- type HybridConnectionsClientDeleteAuthorizationRuleResponse
- type HybridConnectionsClientDeleteOptions
- type HybridConnectionsClientDeleteResponse
- type HybridConnectionsClientGetAuthorizationRuleOptions
- type HybridConnectionsClientGetAuthorizationRuleResponse
- type HybridConnectionsClientGetOptions
- type HybridConnectionsClientGetResponse
- type HybridConnectionsClientListAuthorizationRulesOptions
- type HybridConnectionsClientListAuthorizationRulesResponse
- type HybridConnectionsClientListByNamespaceOptions
- type HybridConnectionsClientListByNamespaceResponse
- type HybridConnectionsClientListKeysOptions
- type HybridConnectionsClientListKeysResponse
- type HybridConnectionsClientRegenerateKeysOptions
- type HybridConnectionsClientRegenerateKeysResponse
- type KeyType
- type NWRuleSetIPRules
- type Namespace
- type NamespaceListResult
- type NamespaceProperties
- type NamespacesClient
- func (client *NamespacesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*runtime.Poller[NamespacesClientCreateOrUpdateResponse], error)
- func (client *NamespacesClient) BeginDelete(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*runtime.Poller[NamespacesClientDeleteResponse], error)
- func (client *NamespacesClient) CheckNameAvailability(ctx context.Context, parameters CheckNameAvailability, ...) (NamespacesClientCheckNameAvailabilityResponse, error)
- func (client *NamespacesClient) CreateOrUpdateAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, ...) (NamespacesClientCreateOrUpdateAuthorizationRuleResponse, error)
- func (client *NamespacesClient) CreateOrUpdateNetworkRuleSet(ctx context.Context, resourceGroupName string, namespaceName string, ...) (NamespacesClientCreateOrUpdateNetworkRuleSetResponse, error)
- func (client *NamespacesClient) DeleteAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, ...) (NamespacesClientDeleteAuthorizationRuleResponse, error)
- func (client *NamespacesClient) Get(ctx context.Context, resourceGroupName string, namespaceName string, ...) (NamespacesClientGetResponse, error)
- func (client *NamespacesClient) GetAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, ...) (NamespacesClientGetAuthorizationRuleResponse, error)
- func (client *NamespacesClient) GetNetworkRuleSet(ctx context.Context, resourceGroupName string, namespaceName string, ...) (NamespacesClientGetNetworkRuleSetResponse, error)
- func (client *NamespacesClient) ListKeys(ctx context.Context, resourceGroupName string, namespaceName string, ...) (NamespacesClientListKeysResponse, error)
- func (client *NamespacesClient) NewListAuthorizationRulesPager(resourceGroupName string, namespaceName string, ...) *runtime.Pager[NamespacesClientListAuthorizationRulesResponse]
- func (client *NamespacesClient) NewListByResourceGroupPager(resourceGroupName string, options *NamespacesClientListByResourceGroupOptions) *runtime.Pager[NamespacesClientListByResourceGroupResponse]
- func (client *NamespacesClient) NewListPager(options *NamespacesClientListOptions) *runtime.Pager[NamespacesClientListResponse]
- func (client *NamespacesClient) RegenerateKeys(ctx context.Context, resourceGroupName string, namespaceName string, ...) (NamespacesClientRegenerateKeysResponse, error)
- func (client *NamespacesClient) Update(ctx context.Context, resourceGroupName string, namespaceName string, ...) (NamespacesClientUpdateResponse, error)
- type NamespacesClientBeginCreateOrUpdateOptions
- type NamespacesClientBeginDeleteOptions
- type NamespacesClientCheckNameAvailabilityOptions
- type NamespacesClientCheckNameAvailabilityResponse
- type NamespacesClientCreateOrUpdateAuthorizationRuleOptions
- type NamespacesClientCreateOrUpdateAuthorizationRuleResponse
- type NamespacesClientCreateOrUpdateNetworkRuleSetOptions
- type NamespacesClientCreateOrUpdateNetworkRuleSetResponse
- type NamespacesClientCreateOrUpdateResponse
- type NamespacesClientDeleteAuthorizationRuleOptions
- type NamespacesClientDeleteAuthorizationRuleResponse
- type NamespacesClientDeleteResponse
- type NamespacesClientGetAuthorizationRuleOptions
- type NamespacesClientGetAuthorizationRuleResponse
- type NamespacesClientGetNetworkRuleSetOptions
- type NamespacesClientGetNetworkRuleSetResponse
- type NamespacesClientGetOptions
- type NamespacesClientGetResponse
- type NamespacesClientListAuthorizationRulesOptions
- type NamespacesClientListAuthorizationRulesResponse
- type NamespacesClientListByResourceGroupOptions
- type NamespacesClientListByResourceGroupResponse
- type NamespacesClientListKeysOptions
- type NamespacesClientListKeysResponse
- type NamespacesClientListOptions
- type NamespacesClientListResponse
- type NamespacesClientRegenerateKeysOptions
- type NamespacesClientRegenerateKeysResponse
- type NamespacesClientUpdateOptions
- type NamespacesClientUpdateResponse
- type NetworkRuleIPAction
- type NetworkRuleSet
- type NetworkRuleSetProperties
- type Operation
- type OperationDisplay
- type OperationListResult
- type OperationsClient
- type OperationsClientListOptions
- type OperationsClientListResponse
- type Origin
- type PrivateEndpoint
- type PrivateEndpointConnection
- type PrivateEndpointConnectionListResult
- type PrivateEndpointConnectionProperties
- type PrivateEndpointConnectionsClient
- func (client *PrivateEndpointConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, namespaceName string, ...) (*runtime.Poller[PrivateEndpointConnectionsClientDeleteResponse], error)
- func (client *PrivateEndpointConnectionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, namespaceName string, ...) (PrivateEndpointConnectionsClientCreateOrUpdateResponse, error)
- func (client *PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, namespaceName string, ...) (PrivateEndpointConnectionsClientGetResponse, error)
- func (client *PrivateEndpointConnectionsClient) NewListPager(resourceGroupName string, namespaceName string, ...) *runtime.Pager[PrivateEndpointConnectionsClientListResponse]
- type PrivateEndpointConnectionsClientBeginDeleteOptions
- type PrivateEndpointConnectionsClientCreateOrUpdateOptions
- type PrivateEndpointConnectionsClientCreateOrUpdateResponse
- type PrivateEndpointConnectionsClientDeleteResponse
- type PrivateEndpointConnectionsClientGetOptions
- type PrivateEndpointConnectionsClientGetResponse
- type PrivateEndpointConnectionsClientListOptions
- type PrivateEndpointConnectionsClientListResponse
- type PrivateLinkConnectionStatus
- type PrivateLinkResource
- type PrivateLinkResourceProperties
- type PrivateLinkResourcesClient
- func (client *PrivateLinkResourcesClient) Get(ctx context.Context, resourceGroupName string, namespaceName string, ...) (PrivateLinkResourcesClientGetResponse, error)
- func (client *PrivateLinkResourcesClient) List(ctx context.Context, resourceGroupName string, namespaceName string, ...) (PrivateLinkResourcesClientListResponse, error)
- type PrivateLinkResourcesClientGetOptions
- type PrivateLinkResourcesClientGetResponse
- type PrivateLinkResourcesClientListOptions
- type PrivateLinkResourcesClientListResponse
- type PrivateLinkResourcesListResult
- type PublicNetworkAccess
- type RegenerateAccessKeyParameters
- type Relaytype
- type SKU
- type SKUName
- type SKUTier
- type SystemData
- type TLSVersion
- type UnavailableReason
- type UpdateParameters
- type WCFRelaysClient
- func (client *WCFRelaysClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, namespaceName string, ...) (WCFRelaysClientCreateOrUpdateResponse, error)
- func (client *WCFRelaysClient) CreateOrUpdateAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, ...) (WCFRelaysClientCreateOrUpdateAuthorizationRuleResponse, error)
- func (client *WCFRelaysClient) Delete(ctx context.Context, resourceGroupName string, namespaceName string, ...) (WCFRelaysClientDeleteResponse, error)
- func (client *WCFRelaysClient) DeleteAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, ...) (WCFRelaysClientDeleteAuthorizationRuleResponse, error)
- func (client *WCFRelaysClient) Get(ctx context.Context, resourceGroupName string, namespaceName string, ...) (WCFRelaysClientGetResponse, error)
- func (client *WCFRelaysClient) GetAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, ...) (WCFRelaysClientGetAuthorizationRuleResponse, error)
- func (client *WCFRelaysClient) ListKeys(ctx context.Context, resourceGroupName string, namespaceName string, ...) (WCFRelaysClientListKeysResponse, error)
- func (client *WCFRelaysClient) NewListAuthorizationRulesPager(resourceGroupName string, namespaceName string, relayName string, ...) *runtime.Pager[WCFRelaysClientListAuthorizationRulesResponse]
- func (client *WCFRelaysClient) NewListByNamespacePager(resourceGroupName string, namespaceName string, ...) *runtime.Pager[WCFRelaysClientListByNamespaceResponse]
- func (client *WCFRelaysClient) RegenerateKeys(ctx context.Context, resourceGroupName string, namespaceName string, ...) (WCFRelaysClientRegenerateKeysResponse, error)
- type WCFRelaysClientCreateOrUpdateAuthorizationRuleOptions
- type WCFRelaysClientCreateOrUpdateAuthorizationRuleResponse
- type WCFRelaysClientCreateOrUpdateOptions
- type WCFRelaysClientCreateOrUpdateResponse
- type WCFRelaysClientDeleteAuthorizationRuleOptions
- type WCFRelaysClientDeleteAuthorizationRuleResponse
- type WCFRelaysClientDeleteOptions
- type WCFRelaysClientDeleteResponse
- type WCFRelaysClientGetAuthorizationRuleOptions
- type WCFRelaysClientGetAuthorizationRuleResponse
- type WCFRelaysClientGetOptions
- type WCFRelaysClientGetResponse
- type WCFRelaysClientListAuthorizationRulesOptions
- type WCFRelaysClientListAuthorizationRulesResponse
- type WCFRelaysClientListByNamespaceOptions
- type WCFRelaysClientListByNamespaceResponse
- type WCFRelaysClientListKeysOptions
- type WCFRelaysClientListKeysResponse
- type WCFRelaysClientRegenerateKeysOptions
- type WCFRelaysClientRegenerateKeysResponse
- type WcfRelay
- type WcfRelayProperties
- type WcfRelaysListResult
Examples ¶
- HybridConnectionsClient.CreateOrUpdate
- HybridConnectionsClient.CreateOrUpdateAuthorizationRule
- HybridConnectionsClient.Delete
- HybridConnectionsClient.DeleteAuthorizationRule
- HybridConnectionsClient.Get
- HybridConnectionsClient.GetAuthorizationRule
- HybridConnectionsClient.ListKeys
- HybridConnectionsClient.NewListAuthorizationRulesPager
- HybridConnectionsClient.NewListByNamespacePager
- HybridConnectionsClient.RegenerateKeys
- NamespacesClient.BeginCreateOrUpdate
- NamespacesClient.BeginDelete
- NamespacesClient.CheckNameAvailability
- NamespacesClient.CreateOrUpdateAuthorizationRule
- NamespacesClient.CreateOrUpdateNetworkRuleSet
- NamespacesClient.DeleteAuthorizationRule
- NamespacesClient.Get
- NamespacesClient.GetAuthorizationRule
- NamespacesClient.GetNetworkRuleSet
- NamespacesClient.ListKeys
- NamespacesClient.NewListAuthorizationRulesPager
- NamespacesClient.NewListByResourceGroupPager
- NamespacesClient.NewListPager
- NamespacesClient.RegenerateKeys
- NamespacesClient.Update
- OperationsClient.NewListPager
- PrivateEndpointConnectionsClient.BeginDelete
- PrivateEndpointConnectionsClient.CreateOrUpdate
- PrivateEndpointConnectionsClient.Get
- PrivateEndpointConnectionsClient.NewListPager
- PrivateLinkResourcesClient.Get
- PrivateLinkResourcesClient.List
- WCFRelaysClient.CreateOrUpdate
- WCFRelaysClient.CreateOrUpdateAuthorizationRule
- WCFRelaysClient.Delete
- WCFRelaysClient.DeleteAuthorizationRule
- WCFRelaysClient.Get
- WCFRelaysClient.GetAuthorizationRule
- WCFRelaysClient.ListKeys
- WCFRelaysClient.NewListAuthorizationRulesPager
- WCFRelaysClient.NewListByNamespacePager
- WCFRelaysClient.RegenerateKeys
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessKeys ¶
type AccessKeys struct {
// A string that describes the authorization rule.
KeyName *string
// Primary connection string of the created namespace authorization rule.
PrimaryConnectionString *string
// A base64-encoded 256-bit primary key for signing and validating the SAS token.
PrimaryKey *string
// Secondary connection string of the created namespace authorization rule.
SecondaryConnectionString *string
// A base64-encoded 256-bit secondary key for signing and validating the SAS token.
SecondaryKey *string
}
AccessKeys - Namespace/Relay Connection String
func (AccessKeys) MarshalJSON ¶
func (a AccessKeys) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AccessKeys.
func (*AccessKeys) UnmarshalJSON ¶
func (a *AccessKeys) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AccessKeys.
type AccessRights ¶
type AccessRights string
const ( AccessRightsListen AccessRights = "Listen" AccessRightsManage AccessRights = "Manage" AccessRightsSend AccessRights = "Send" )
func PossibleAccessRightsValues ¶
func PossibleAccessRightsValues() []AccessRights
PossibleAccessRightsValues returns the possible values for the AccessRights const type.
type ActionType ¶
type ActionType string
ActionType - Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
const ( // ActionTypeInternal - Actions are for internal-only APIs. ActionTypeInternal ActionType = "Internal" )
func PossibleActionTypeValues ¶
func PossibleActionTypeValues() []ActionType
PossibleActionTypeValues returns the possible values for the ActionType const type.
type AuthorizationRule ¶
type AuthorizationRule struct {
// Properties supplied to create or update AuthorizationRule
Properties *AuthorizationRuleProperties
// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ID *string
// READ-ONLY; The geo-location where the resource lives
Location *string
// READ-ONLY; The name of the resource
Name *string
// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
SystemData *SystemData
// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string
}
AuthorizationRule - Single item in a List or Get AuthorizationRule operation
func (AuthorizationRule) MarshalJSON ¶
func (a AuthorizationRule) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AuthorizationRule.
func (*AuthorizationRule) UnmarshalJSON ¶
func (a *AuthorizationRule) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AuthorizationRule.
type AuthorizationRuleListResult ¶
type AuthorizationRuleListResult struct {
// REQUIRED; The AuthorizationRule items on this page
Value []*AuthorizationRule
// The link to the next page of items
NextLink *string
}
AuthorizationRuleListResult - The response of a AuthorizationRule list operation.
func (AuthorizationRuleListResult) MarshalJSON ¶
func (a AuthorizationRuleListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AuthorizationRuleListResult.
func (*AuthorizationRuleListResult) UnmarshalJSON ¶
func (a *AuthorizationRuleListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AuthorizationRuleListResult.
type AuthorizationRuleProperties ¶
type AuthorizationRuleProperties struct {
// REQUIRED; The rights associated with the rule.
Rights []*AccessRights
}
AuthorizationRuleProperties - Properties supplied to create or update AuthorizationRule
func (AuthorizationRuleProperties) MarshalJSON ¶
func (a AuthorizationRuleProperties) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AuthorizationRuleProperties.
func (*AuthorizationRuleProperties) UnmarshalJSON ¶
func (a *AuthorizationRuleProperties) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AuthorizationRuleProperties.
type CheckNameAvailability ¶
type CheckNameAvailability struct {
// REQUIRED; The namespace name to check for availability. The namespace name can contain only letters, numbers, and hyphens.
// The namespace must start with a letter, and it must end with a letter or number.
Name *string
}
CheckNameAvailability - Description of the check name availability request properties.
func (CheckNameAvailability) MarshalJSON ¶
func (c CheckNameAvailability) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type CheckNameAvailability.
func (*CheckNameAvailability) UnmarshalJSON ¶
func (c *CheckNameAvailability) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type CheckNameAvailability.
type CheckNameAvailabilityResult ¶
type CheckNameAvailabilityResult struct {
// Value indicating namespace is available. Returns true if the namespace is available; otherwise, false.
NameAvailable *bool
// The reason for unavailability of a namespace.
Reason *UnavailableReason
// READ-ONLY; The detailed info regarding the reason associated with the namespace.
Message *string
}
CheckNameAvailabilityResult - Description of the check name availability request properties.
func (CheckNameAvailabilityResult) MarshalJSON ¶
func (c CheckNameAvailabilityResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type CheckNameAvailabilityResult.
func (*CheckNameAvailabilityResult) UnmarshalJSON ¶
func (c *CheckNameAvailabilityResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type CheckNameAvailabilityResult.
type ClientFactory ¶
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 ¶
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. The value must be an UUID.
- credential - used to authorize requests. Usually a credential from azidentity.
- options - pass nil to accept the default values.
func (*ClientFactory) NewHybridConnectionsClient ¶
func (c *ClientFactory) NewHybridConnectionsClient() *HybridConnectionsClient
NewHybridConnectionsClient creates a new instance of HybridConnectionsClient.
func (*ClientFactory) NewNamespacesClient ¶
func (c *ClientFactory) NewNamespacesClient() *NamespacesClient
NewNamespacesClient creates a new instance of NamespacesClient.
func (*ClientFactory) NewOperationsClient ¶
func (c *ClientFactory) NewOperationsClient() *OperationsClient
NewOperationsClient creates a new instance of OperationsClient.
func (*ClientFactory) NewPrivateEndpointConnectionsClient ¶
func (c *ClientFactory) NewPrivateEndpointConnectionsClient() *PrivateEndpointConnectionsClient
NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient.
func (*ClientFactory) NewPrivateLinkResourcesClient ¶
func (c *ClientFactory) NewPrivateLinkResourcesClient() *PrivateLinkResourcesClient
NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient.
func (*ClientFactory) NewWCFRelaysClient ¶
func (c *ClientFactory) NewWCFRelaysClient() *WCFRelaysClient
NewWCFRelaysClient creates a new instance of WCFRelaysClient.
type ConnectionState ¶
type ConnectionState struct {
// Description of the connection state.
Description *string
// Status of the connection.
Status *PrivateLinkConnectionStatus
}
ConnectionState information.
func (ConnectionState) MarshalJSON ¶
func (c ConnectionState) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ConnectionState.
func (*ConnectionState) UnmarshalJSON ¶
func (c *ConnectionState) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionState.
type CreatedByType ¶
type CreatedByType string
CreatedByType - The kind of entity that created the resource.
const ( // CreatedByTypeApplication - The entity was created by an application. CreatedByTypeApplication CreatedByType = "Application" // CreatedByTypeKey - The entity was created by a key. CreatedByTypeKey CreatedByType = "Key" // CreatedByTypeManagedIdentity - The entity was created by a managed identity. CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity" // CreatedByTypeUser - The entity was created by a user. CreatedByTypeUser CreatedByType = "User" )
func PossibleCreatedByTypeValues ¶
func PossibleCreatedByTypeValues() []CreatedByType
PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.
type DefaultAction ¶
type DefaultAction string
DefaultAction - Default Action for Network Rule Set
const ( DefaultActionAllow DefaultAction = "Allow" DefaultActionDeny DefaultAction = "Deny" )
func PossibleDefaultActionValues ¶
func PossibleDefaultActionValues() []DefaultAction
PossibleDefaultActionValues returns the possible values for the DefaultAction const type.
type EndPointProvisioningState ¶
type EndPointProvisioningState string
EndPointProvisioningState - Provisioning state of the Private Endpoint Connection.
const ( EndPointProvisioningStateCanceled EndPointProvisioningState = "Canceled" EndPointProvisioningStateCreating EndPointProvisioningState = "Creating" EndPointProvisioningStateDeleting EndPointProvisioningState = "Deleting" EndPointProvisioningStateFailed EndPointProvisioningState = "Failed" EndPointProvisioningStateSucceeded EndPointProvisioningState = "Succeeded" EndPointProvisioningStateUpdating EndPointProvisioningState = "Updating" )
func PossibleEndPointProvisioningStateValues ¶
func PossibleEndPointProvisioningStateValues() []EndPointProvisioningState
PossibleEndPointProvisioningStateValues returns the possible values for the EndPointProvisioningState const type.
type HybridConnection ¶
type HybridConnection struct {
// Properties of the HybridConnection.
Properties *HybridConnectionProperties
// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ID *string
// READ-ONLY; The geo-location where the resource lives
Location *string
// READ-ONLY; The name of the resource
Name *string
// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
SystemData *SystemData
// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string
}
HybridConnection - Description of hybrid connection resource.
func (HybridConnection) MarshalJSON ¶
func (h HybridConnection) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type HybridConnection.
func (*HybridConnection) UnmarshalJSON ¶
func (h *HybridConnection) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type HybridConnection.
type HybridConnectionListResult ¶
type HybridConnectionListResult struct {
// REQUIRED; The HybridConnection items on this page
Value []*HybridConnection
// The link to the next page of items
NextLink *string
}
HybridConnectionListResult - The response of a HybridConnection list operation.
func (HybridConnectionListResult) MarshalJSON ¶
func (h HybridConnectionListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type HybridConnectionListResult.
func (*HybridConnectionListResult) UnmarshalJSON ¶
func (h *HybridConnectionListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type HybridConnectionListResult.
type HybridConnectionProperties ¶
type HybridConnectionProperties struct {
// Returns true if client authorization is needed for this hybrid connection; otherwise, false.
RequiresClientAuthorization *bool
// The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it
// can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration
// settings can be stored.
UserMetadata *string
// READ-ONLY; The time the hybrid connection was created.
CreatedAt *time.Time
// READ-ONLY; The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported.
ListenerCount *int32
// READ-ONLY; The time the namespace was updated.
UpdatedAt *time.Time
}
HybridConnectionProperties - Properties of the HybridConnection.
func (HybridConnectionProperties) MarshalJSON ¶
func (h HybridConnectionProperties) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type HybridConnectionProperties.
func (*HybridConnectionProperties) UnmarshalJSON ¶
func (h *HybridConnectionProperties) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type HybridConnectionProperties.
type HybridConnectionsClient ¶
type HybridConnectionsClient struct {
// contains filtered or unexported fields
}
HybridConnectionsClient contains the methods for the HybridConnections group. Don't use this type directly, use NewHybridConnectionsClient() instead.
Generated from API version 2026-01-01
func NewHybridConnectionsClient ¶
func NewHybridConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*HybridConnectionsClient, error)
NewHybridConnectionsClient creates a new instance of HybridConnectionsClient with the specified values.
- subscriptionID - The ID of the target subscription. The value must be an UUID.
- credential - used to authorize requests. Usually a credential from azidentity.
- options - Contains optional client configuration. Pass nil to accept the default values.
func (*HybridConnectionsClient) CreateOrUpdate ¶
func (client *HybridConnectionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string, parameters HybridConnection, options *HybridConnectionsClientCreateOrUpdateOptions) (HybridConnectionsClientCreateOrUpdateResponse, error)
CreateOrUpdate - Creates or updates a service hybrid connection. This operation is idempotent. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- hybridConnectionName - The hybrid connection name.
- parameters - Parameters supplied to create a hybrid connection.
- options - HybridConnectionsClientCreateOrUpdateOptions contains the optional parameters for the HybridConnectionsClient.CreateOrUpdate method.
Example ¶
Generated from example definition: 2026-01-01/HybridConnection/RelayHybridConnectionCreate.json
package main
import (
"context"
"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/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewHybridConnectionsClient().CreateOrUpdate(ctx, "resourcegroup", "example-RelayNamespace-01", "example-Relay-Hybrid-01", armrelay.HybridConnection{
Properties: &armrelay.HybridConnectionProperties{
RequiresClientAuthorization: to.Ptr(true),
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.HybridConnectionsClientCreateOrUpdateResponse{
// HybridConnection: armrelay.HybridConnection{
// Name: to.Ptr("example-Relay-Hybrid-01"),
// Type: to.Ptr("Microsoft.Relay/Namespaces/HybridConnections"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/HybridConnections/example-Relay-Hybrid-01"),
// Properties: &armrelay.HybridConnectionProperties{
// CreatedAt: to.Ptr(time.Date(2017, time.January, 23, 20, 34, 49, 413172400, time.UTC)),
// RequiresClientAuthorization: to.Ptr(true),
// UpdatedAt: to.Ptr(time.Date(2017, time.January, 23, 20, 34, 49, 413172400, time.UTC)),
// },
// },
// }
}
Output:
func (*HybridConnectionsClient) CreateOrUpdateAuthorizationRule ¶
func (client *HybridConnectionsClient) CreateOrUpdateAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string, authorizationRuleName string, parameters AuthorizationRule, options *HybridConnectionsClientCreateOrUpdateAuthorizationRuleOptions) (HybridConnectionsClientCreateOrUpdateAuthorizationRuleResponse, error)
CreateOrUpdateAuthorizationRule - Creates or updates an authorization rule for a hybrid connection. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- hybridConnectionName - The hybrid connection name.
- authorizationRuleName - The authorization rule name.
- parameters - The authorization rule parameters.
- options - HybridConnectionsClientCreateOrUpdateAuthorizationRuleOptions contains the optional parameters for the HybridConnectionsClient.CreateOrUpdateAuthorizationRule method.
Example ¶
Generated from example definition: 2026-01-01/HybridConnection/RelayHybridConnectionAuthorizationRuleCreate.json
package main
import (
"context"
"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/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewHybridConnectionsClient().CreateOrUpdateAuthorizationRule(ctx, "resourcegroup", "example-RelayNamespace-01", "example-Relay-Hybrid-01", "example-RelayAuthRules-01", armrelay.AuthorizationRule{
Properties: &armrelay.AuthorizationRuleProperties{
Rights: []*armrelay.AccessRights{
to.Ptr(armrelay.AccessRightsListen),
to.Ptr(armrelay.AccessRightsSend),
},
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.HybridConnectionsClientCreateOrUpdateAuthorizationRuleResponse{
// AuthorizationRule: armrelay.AuthorizationRule{
// Name: to.Ptr("example-RelayAuthRules-01"),
// Type: to.Ptr("Microsoft.Relay/Namespaces/Hybridconnections/AuthorizationRules"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/HybridConnections/example-Relay-Hybrid-01/AuthorizationRules/example-RelayAuthRules-01"),
// Properties: &armrelay.AuthorizationRuleProperties{
// Rights: []*armrelay.AccessRights{
// to.Ptr(armrelay.AccessRightsListen),
// to.Ptr(armrelay.AccessRightsSend),
// },
// },
// },
// }
}
Output:
func (*HybridConnectionsClient) Delete ¶
func (client *HybridConnectionsClient) Delete(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string, options *HybridConnectionsClientDeleteOptions) (HybridConnectionsClientDeleteResponse, error)
Delete - Deletes a hybrid connection. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- hybridConnectionName - The hybrid connection name.
- options - HybridConnectionsClientDeleteOptions contains the optional parameters for the HybridConnectionsClient.Delete method.
Example ¶
Generated from example definition: 2026-01-01/HybridConnection/RelayHybridconnectionDelete.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewHybridConnectionsClient().Delete(ctx, "resourcegroup", "example-RelayNamespace-01", "example-Relay-Hybrid-01", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.HybridConnectionsClientDeleteResponse{
// }
}
Output:
func (*HybridConnectionsClient) DeleteAuthorizationRule ¶
func (client *HybridConnectionsClient) DeleteAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string, authorizationRuleName string, options *HybridConnectionsClientDeleteAuthorizationRuleOptions) (HybridConnectionsClientDeleteAuthorizationRuleResponse, error)
DeleteAuthorizationRule - Deletes a hybrid connection authorization rule. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- hybridConnectionName - The hybrid connection name.
- authorizationRuleName - The authorization rule name.
- options - HybridConnectionsClientDeleteAuthorizationRuleOptions contains the optional parameters for the HybridConnectionsClient.DeleteAuthorizationRule method.
Example ¶
Generated from example definition: 2026-01-01/HybridConnection/RelayHybridConnectionAuthorizationRuleDelete.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewHybridConnectionsClient().DeleteAuthorizationRule(ctx, "resourcegroup", "example-RelayNamespace-01", "example-Relay-Hybrid-01", "example-RelayAuthRules-01", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.HybridConnectionsClientDeleteAuthorizationRuleResponse{
// }
}
Output:
func (*HybridConnectionsClient) Get ¶
func (client *HybridConnectionsClient) Get(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string, options *HybridConnectionsClientGetOptions) (HybridConnectionsClientGetResponse, error)
Get - Returns the description for the specified hybrid connection. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- hybridConnectionName - The hybrid connection name.
- options - HybridConnectionsClientGetOptions contains the optional parameters for the HybridConnectionsClient.Get method.
Example ¶
Generated from example definition: 2026-01-01/HybridConnection/RelayHybridConnectionGet.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewHybridConnectionsClient().Get(ctx, "resourcegroup", "example-RelayNamespace-01", "example-Relay-Hybrid-01", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.HybridConnectionsClientGetResponse{
// HybridConnection: armrelay.HybridConnection{
// Name: to.Ptr("example-Relay-Hybrid-01"),
// Type: to.Ptr("Microsoft.Relay/Namespaces/HybridConnections"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/HybridConnections/example-Relay-Hybrid-01"),
// Properties: &armrelay.HybridConnectionProperties{
// CreatedAt: to.Ptr(time.Date(2017, time.January, 23, 20, 34, 49, 413172400, time.UTC)),
// ListenerCount: to.Ptr[int32](1),
// RequiresClientAuthorization: to.Ptr(true),
// UpdatedAt: to.Ptr(time.Date(2017, time.January, 23, 20, 34, 49, 413172400, time.UTC)),
// UserMetadata: to.Ptr("usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored."),
// },
// },
// }
}
Output:
func (*HybridConnectionsClient) GetAuthorizationRule ¶
func (client *HybridConnectionsClient) GetAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string, authorizationRuleName string, options *HybridConnectionsClientGetAuthorizationRuleOptions) (HybridConnectionsClientGetAuthorizationRuleResponse, error)
GetAuthorizationRule - Hybrid connection authorization rule for a hybrid connection by name. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- hybridConnectionName - The hybrid connection name.
- authorizationRuleName - The authorization rule name.
- options - HybridConnectionsClientGetAuthorizationRuleOptions contains the optional parameters for the HybridConnectionsClient.GetAuthorizationRule method.
Example ¶
Generated from example definition: 2026-01-01/HybridConnection/RelayHybridConnectionAuthorizationRuleGet.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewHybridConnectionsClient().GetAuthorizationRule(ctx, "resourcegroup", "example-RelayNamespace-01", "example-Relay-Hybrid-01", "example-RelayAuthRules-01", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.HybridConnectionsClientGetAuthorizationRuleResponse{
// AuthorizationRule: armrelay.AuthorizationRule{
// Name: to.Ptr("example-RelayAuthRules-01"),
// Type: to.Ptr("Microsoft.Relay/Namespaces/Hybridconnections/AuthorizationRules"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/HybridConnections/example-Relay-Hybrid-01/AuthorizationRules/example-RelayAuthRules-01"),
// Properties: &armrelay.AuthorizationRuleProperties{
// Rights: []*armrelay.AccessRights{
// to.Ptr(armrelay.AccessRightsListen),
// },
// },
// },
// }
}
Output:
func (*HybridConnectionsClient) ListKeys ¶
func (client *HybridConnectionsClient) ListKeys(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string, authorizationRuleName string, options *HybridConnectionsClientListKeysOptions) (HybridConnectionsClientListKeysResponse, error)
ListKeys - Primary and secondary connection strings to the hybrid connection. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- hybridConnectionName - The hybrid connection name.
- authorizationRuleName - The authorization rule name.
- options - HybridConnectionsClientListKeysOptions contains the optional parameters for the HybridConnectionsClient.ListKeys method.
Example ¶
Generated from example definition: 2026-01-01/HybridConnection/RelayHybridConnectionAuthorizationRuleListKey.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewHybridConnectionsClient().ListKeys(ctx, "resourcegroup", "example-RelayNamespace-01", "example-Relay-Hybrid-01", "example-RelayAuthRules-01", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.HybridConnectionsClientListKeysResponse{
// AccessKeys: armrelay.AccessKeys{
// KeyName: to.Ptr("example-RelayAuthRules-01"),
// PrimaryConnectionString: to.Ptr("Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################"),
// PrimaryKey: to.Ptr("############################################"),
// SecondaryConnectionString: to.Ptr("Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################"),
// SecondaryKey: to.Ptr("############################################"),
// },
// }
}
Output:
func (*HybridConnectionsClient) NewListAuthorizationRulesPager ¶
func (client *HybridConnectionsClient) NewListAuthorizationRulesPager(resourceGroupName string, namespaceName string, hybridConnectionName string, options *HybridConnectionsClientListAuthorizationRulesOptions) *runtime.Pager[HybridConnectionsClientListAuthorizationRulesResponse]
NewListAuthorizationRulesPager - Authorization rules for a hybrid connection.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- hybridConnectionName - The hybrid connection name.
- options - HybridConnectionsClientListAuthorizationRulesOptions contains the optional parameters for the HybridConnectionsClient.NewListAuthorizationRulesPager method.
Example ¶
Generated from example definition: 2026-01-01/HybridConnection/RelayHybridConnectionAuthorizationRuleListAll.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewHybridConnectionsClient().NewListAuthorizationRulesPager("resourcegroup", "example-RelayNamespace-01", "example-Relay-Hybrid-01", 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 = armrelay.HybridConnectionsClientListAuthorizationRulesResponse{
// AuthorizationRuleListResult: armrelay.AuthorizationRuleListResult{
// Value: []*armrelay.AuthorizationRule{
// {
// Name: to.Ptr("example-RelayAuthRules-01"),
// Type: to.Ptr("Microsoft.Relay/Namespaces/Hybridconnections/AuthorizationRules"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/HybridConnections/example-Relay-Hybrid-01/AuthorizationRules/example-RelayAuthRules-01"),
// Properties: &armrelay.AuthorizationRuleProperties{
// Rights: []*armrelay.AccessRights{
// to.Ptr(armrelay.AccessRightsListen),
// to.Ptr(armrelay.AccessRightsSend),
// },
// },
// },
// },
// },
// }
}
}
Output:
func (*HybridConnectionsClient) NewListByNamespacePager ¶
func (client *HybridConnectionsClient) NewListByNamespacePager(resourceGroupName string, namespaceName string, options *HybridConnectionsClientListByNamespaceOptions) *runtime.Pager[HybridConnectionsClientListByNamespaceResponse]
NewListByNamespacePager - Lists the hybrid connection within the namespace.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- options - HybridConnectionsClientListByNamespaceOptions contains the optional parameters for the HybridConnectionsClient.NewListByNamespacePager method.
Example ¶
Generated from example definition: 2026-01-01/HybridConnection/RelayHybridConnectionListAll.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewHybridConnectionsClient().NewListByNamespacePager("resourcegroup", "example-RelayNamespace-01", 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 = armrelay.HybridConnectionsClientListByNamespaceResponse{
// HybridConnectionListResult: armrelay.HybridConnectionListResult{
// Value: []*armrelay.HybridConnection{
// {
// Name: to.Ptr("example-Relay-Hybrid-01"),
// Type: to.Ptr("Microsoft.Relay/Namespaces/HybridConnections"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/HybridConnections/example-Relay-Hybrid-01"),
// Properties: &armrelay.HybridConnectionProperties{
// CreatedAt: to.Ptr(time.Date(2017, time.January, 23, 20, 34, 49, 413172400, time.UTC)),
// ListenerCount: to.Ptr[int32](1),
// RequiresClientAuthorization: to.Ptr(true),
// UpdatedAt: to.Ptr(time.Date(2017, time.January, 23, 20, 34, 49, 413172400, time.UTC)),
// UserMetadata: to.Ptr("usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored."),
// },
// },
// },
// },
// }
}
}
Output:
func (*HybridConnectionsClient) RegenerateKeys ¶
func (client *HybridConnectionsClient) RegenerateKeys(ctx context.Context, resourceGroupName string, namespaceName string, hybridConnectionName string, authorizationRuleName string, parameters RegenerateAccessKeyParameters, options *HybridConnectionsClientRegenerateKeysOptions) (HybridConnectionsClientRegenerateKeysResponse, error)
RegenerateKeys - Regenerates the primary or secondary connection strings to the hybrid connection. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- hybridConnectionName - The hybrid connection name.
- authorizationRuleName - The authorization rule name.
- parameters - Parameters supplied to regenerate authorization rule.
- options - HybridConnectionsClientRegenerateKeysOptions contains the optional parameters for the HybridConnectionsClient.RegenerateKeys method.
Example ¶
Generated from example definition: 2026-01-01/HybridConnection/RelayHybridConnectionAuthorizationRuleRegenerateKey.json
package main
import (
"context"
"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/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewHybridConnectionsClient().RegenerateKeys(ctx, "resourcegroup", "example-RelayNamespace-01", "example-Relay-Hybrid-01", "example-RelayAuthRules-01", armrelay.RegenerateAccessKeyParameters{
KeyType: to.Ptr(armrelay.KeyTypePrimaryKey),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.HybridConnectionsClientRegenerateKeysResponse{
// AccessKeys: armrelay.AccessKeys{
// KeyName: to.Ptr("example-RelayAuthRules-01"),
// PrimaryConnectionString: to.Ptr("Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################"),
// PrimaryKey: to.Ptr("############################################"),
// SecondaryConnectionString: to.Ptr("Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################"),
// SecondaryKey: to.Ptr("############################################"),
// },
// }
}
Output:
type HybridConnectionsClientCreateOrUpdateAuthorizationRuleOptions ¶
type HybridConnectionsClientCreateOrUpdateAuthorizationRuleOptions struct {
}
HybridConnectionsClientCreateOrUpdateAuthorizationRuleOptions contains the optional parameters for the HybridConnectionsClient.CreateOrUpdateAuthorizationRule method.
type HybridConnectionsClientCreateOrUpdateAuthorizationRuleResponse ¶
type HybridConnectionsClientCreateOrUpdateAuthorizationRuleResponse struct {
// Single item in a List or Get AuthorizationRule operation
AuthorizationRule
}
HybridConnectionsClientCreateOrUpdateAuthorizationRuleResponse contains the response from method HybridConnectionsClient.CreateOrUpdateAuthorizationRule.
type HybridConnectionsClientCreateOrUpdateOptions ¶
type HybridConnectionsClientCreateOrUpdateOptions struct {
}
HybridConnectionsClientCreateOrUpdateOptions contains the optional parameters for the HybridConnectionsClient.CreateOrUpdate method.
type HybridConnectionsClientCreateOrUpdateResponse ¶
type HybridConnectionsClientCreateOrUpdateResponse struct {
// Description of hybrid connection resource.
HybridConnection
}
HybridConnectionsClientCreateOrUpdateResponse contains the response from method HybridConnectionsClient.CreateOrUpdate.
type HybridConnectionsClientDeleteAuthorizationRuleOptions ¶
type HybridConnectionsClientDeleteAuthorizationRuleOptions struct {
}
HybridConnectionsClientDeleteAuthorizationRuleOptions contains the optional parameters for the HybridConnectionsClient.DeleteAuthorizationRule method.
type HybridConnectionsClientDeleteAuthorizationRuleResponse ¶
type HybridConnectionsClientDeleteAuthorizationRuleResponse struct {
}
HybridConnectionsClientDeleteAuthorizationRuleResponse contains the response from method HybridConnectionsClient.DeleteAuthorizationRule.
type HybridConnectionsClientDeleteOptions ¶
type HybridConnectionsClientDeleteOptions struct {
}
HybridConnectionsClientDeleteOptions contains the optional parameters for the HybridConnectionsClient.Delete method.
type HybridConnectionsClientDeleteResponse ¶
type HybridConnectionsClientDeleteResponse struct {
}
HybridConnectionsClientDeleteResponse contains the response from method HybridConnectionsClient.Delete.
type HybridConnectionsClientGetAuthorizationRuleOptions ¶
type HybridConnectionsClientGetAuthorizationRuleOptions struct {
}
HybridConnectionsClientGetAuthorizationRuleOptions contains the optional parameters for the HybridConnectionsClient.GetAuthorizationRule method.
type HybridConnectionsClientGetAuthorizationRuleResponse ¶
type HybridConnectionsClientGetAuthorizationRuleResponse struct {
// Single item in a List or Get AuthorizationRule operation
AuthorizationRule
}
HybridConnectionsClientGetAuthorizationRuleResponse contains the response from method HybridConnectionsClient.GetAuthorizationRule.
type HybridConnectionsClientGetOptions ¶
type HybridConnectionsClientGetOptions struct {
}
HybridConnectionsClientGetOptions contains the optional parameters for the HybridConnectionsClient.Get method.
type HybridConnectionsClientGetResponse ¶
type HybridConnectionsClientGetResponse struct {
// Description of hybrid connection resource.
HybridConnection
}
HybridConnectionsClientGetResponse contains the response from method HybridConnectionsClient.Get.
type HybridConnectionsClientListAuthorizationRulesOptions ¶
type HybridConnectionsClientListAuthorizationRulesOptions struct {
}
HybridConnectionsClientListAuthorizationRulesOptions contains the optional parameters for the HybridConnectionsClient.NewListAuthorizationRulesPager method.
type HybridConnectionsClientListAuthorizationRulesResponse ¶
type HybridConnectionsClientListAuthorizationRulesResponse struct {
// The response of a AuthorizationRule list operation.
AuthorizationRuleListResult
}
HybridConnectionsClientListAuthorizationRulesResponse contains the response from method HybridConnectionsClient.NewListAuthorizationRulesPager.
type HybridConnectionsClientListByNamespaceOptions ¶
type HybridConnectionsClientListByNamespaceOptions struct {
}
HybridConnectionsClientListByNamespaceOptions contains the optional parameters for the HybridConnectionsClient.NewListByNamespacePager method.
type HybridConnectionsClientListByNamespaceResponse ¶
type HybridConnectionsClientListByNamespaceResponse struct {
// The response of a HybridConnection list operation.
HybridConnectionListResult
}
HybridConnectionsClientListByNamespaceResponse contains the response from method HybridConnectionsClient.NewListByNamespacePager.
type HybridConnectionsClientListKeysOptions ¶
type HybridConnectionsClientListKeysOptions struct {
}
HybridConnectionsClientListKeysOptions contains the optional parameters for the HybridConnectionsClient.ListKeys method.
type HybridConnectionsClientListKeysResponse ¶
type HybridConnectionsClientListKeysResponse struct {
// Namespace/Relay Connection String
AccessKeys
}
HybridConnectionsClientListKeysResponse contains the response from method HybridConnectionsClient.ListKeys.
type HybridConnectionsClientRegenerateKeysOptions ¶
type HybridConnectionsClientRegenerateKeysOptions struct {
}
HybridConnectionsClientRegenerateKeysOptions contains the optional parameters for the HybridConnectionsClient.RegenerateKeys method.
type HybridConnectionsClientRegenerateKeysResponse ¶
type HybridConnectionsClientRegenerateKeysResponse struct {
// Namespace/Relay Connection String
AccessKeys
}
HybridConnectionsClientRegenerateKeysResponse contains the response from method HybridConnectionsClient.RegenerateKeys.
type KeyType ¶
type KeyType string
KeyType - The access key to regenerate.
func PossibleKeyTypeValues ¶
func PossibleKeyTypeValues() []KeyType
PossibleKeyTypeValues returns the possible values for the KeyType const type.
type NWRuleSetIPRules ¶
type NWRuleSetIPRules struct {
// The IP Filter Action
Action *NetworkRuleIPAction
// IP Mask
IPMask *string
}
NWRuleSetIPRules - The response from the List namespace operation.
func (NWRuleSetIPRules) MarshalJSON ¶
func (n NWRuleSetIPRules) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type NWRuleSetIPRules.
func (*NWRuleSetIPRules) UnmarshalJSON ¶
func (n *NWRuleSetIPRules) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type NWRuleSetIPRules.
type Namespace ¶
type Namespace struct {
// REQUIRED; The geo-location where the resource lives
Location *string
// Description of Relay namespace
Properties *NamespaceProperties
// SKU of the namespace.
SKU *SKU
// Resource tags.
Tags map[string]*string
// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ID *string
// READ-ONLY; The name of the resource
Name *string
// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
SystemData *SystemData
// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string
}
Namespace - Description of a namespace resource.
func (Namespace) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type Namespace.
func (*Namespace) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type Namespace.
type NamespaceListResult ¶
type NamespaceListResult struct {
// REQUIRED; The RelayNamespace items on this page
Value []*Namespace
// The link to the next page of items
NextLink *string
}
NamespaceListResult - The response of a RelayNamespace list operation.
func (NamespaceListResult) MarshalJSON ¶
func (n NamespaceListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type NamespaceListResult.
func (*NamespaceListResult) UnmarshalJSON ¶
func (n *NamespaceListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type NamespaceListResult.
type NamespaceProperties ¶
type NamespaceProperties struct {
// The minimum TLS version for the namespace.
// Supported values are 1.2 and 1.3.
// The service defaults to 1.2 when the property is omitted.
// Existing namespaces configured with TLS 1.0 or 1.1 are reported as TLS 1.2.
MinimumTLSVersion *TLSVersion
// List of private endpoint connections.
PrivateEndpointConnections []*PrivateEndpointConnection
// This determines if traffic is allowed over public network. By default it is enabled.
PublicNetworkAccess *PublicNetworkAccess
// READ-ONLY; The time the namespace was created.
CreatedAt *time.Time
// READ-ONLY; Identifier for Azure Insights metrics.
MetricID *string
// READ-ONLY; Provisioning state of the Namespace.
ProvisioningState *string
// READ-ONLY; Endpoint you can use to perform Service Bus operations.
ServiceBusEndpoint *string
// READ-ONLY; Status of the Namespace.
Status *string
// READ-ONLY; The time the namespace was updated.
UpdatedAt *time.Time
}
NamespaceProperties - Properties of the namespace.
func (NamespaceProperties) MarshalJSON ¶
func (n NamespaceProperties) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type NamespaceProperties.
func (*NamespaceProperties) UnmarshalJSON ¶
func (n *NamespaceProperties) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type NamespaceProperties.
type NamespacesClient ¶
type NamespacesClient struct {
// contains filtered or unexported fields
}
NamespacesClient contains the methods for the Namespaces group. Don't use this type directly, use NewNamespacesClient() instead.
Generated from API version 2026-01-01
func NewNamespacesClient ¶
func NewNamespacesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*NamespacesClient, error)
NewNamespacesClient creates a new instance of NamespacesClient with the specified values.
- subscriptionID - The ID of the target subscription. The value must be an UUID.
- credential - used to authorize requests. Usually a credential from azidentity.
- options - Contains optional client configuration. Pass nil to accept the default values.
func (*NamespacesClient) BeginCreateOrUpdate ¶
func (client *NamespacesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, namespaceName string, parameters Namespace, options *NamespacesClientBeginCreateOrUpdateOptions) (*runtime.Poller[NamespacesClientCreateOrUpdateResponse], error)
BeginCreateOrUpdate - Create Azure Relay namespace. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- parameters - Parameters supplied to create a namespace resource.
- options - NamespacesClientBeginCreateOrUpdateOptions contains the optional parameters for the NamespacesClient.BeginCreateOrUpdate method.
Example ¶
Generated from example definition: 2026-01-01/NameSpaces/RelayNameSpaceCreate.json
package main
import (
"context"
"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/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNamespacesClient().BeginCreateOrUpdate(ctx, "resourcegroup", "example-RelayNamespace-5849", armrelay.Namespace{
Location: to.Ptr("South Central US"),
SKU: &armrelay.SKU{
Name: to.Ptr(armrelay.SKUNameStandard),
Tier: to.Ptr(armrelay.SKUTierStandard),
},
Tags: map[string]*string{
"tag1": to.Ptr("value1"),
"tag2": to.Ptr("value2"),
},
Properties: &armrelay.NamespaceProperties{
MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to poll the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.NamespacesClientCreateOrUpdateResponse{
// Namespace: armrelay.Namespace{
// Name: to.Ptr("example-RelayNamespace-5849"),
// Type: to.Ptr("Microsoft.Relay/Namespaces"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-5849"),
// Location: to.Ptr("South Central US"),
// Properties: &armrelay.NamespaceProperties{
// MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relaynamespace-5849"),
// ProvisioningState: to.Ptr("Created"),
// ServiceBusEndpoint: to.Ptr("https://example-RelayNamespace-5849.servicebus.windows-int.net:443/"),
// MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
// },
// SKU: &armrelay.SKU{
// Name: to.Ptr(armrelay.SKUNameStandard),
// Tier: to.Ptr(armrelay.SKUTierStandard),
// },
// Tags: map[string]*string{
// "tag1": to.Ptr("value1"),
// "tag2": to.Ptr("value2"),
// },
// },
// }
}
Output:
func (*NamespacesClient) BeginDelete ¶
func (client *NamespacesClient) BeginDelete(ctx context.Context, resourceGroupName string, namespaceName string, options *NamespacesClientBeginDeleteOptions) (*runtime.Poller[NamespacesClientDeleteResponse], error)
BeginDelete - Deletes an existing namespace. This operation also removes all associated resources under the namespace. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- options - NamespacesClientBeginDeleteOptions contains the optional parameters for the NamespacesClient.BeginDelete method.
Example ¶
Generated from example definition: 2026-01-01/NameSpaces/RelayNameSpaceDelete.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNamespacesClient().BeginDelete(ctx, "SouthCentralUS", "example-RelayNamespace-5849", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to poll the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.NamespacesClientDeleteResponse{
// }
}
Output:
func (*NamespacesClient) CheckNameAvailability ¶
func (client *NamespacesClient) CheckNameAvailability(ctx context.Context, parameters CheckNameAvailability, options *NamespacesClientCheckNameAvailabilityOptions) (NamespacesClientCheckNameAvailabilityResponse, error)
CheckNameAvailability - Check the specified namespace name availability. If the operation fails it returns an *azcore.ResponseError type.
- parameters - The request body
- options - NamespacesClientCheckNameAvailabilityOptions contains the optional parameters for the NamespacesClient.CheckNameAvailability method.
Example ¶
Generated from example definition: 2026-01-01/NameSpaces/RelayNameSpaceCheckNameAvailability.json
package main
import (
"context"
"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/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNamespacesClient().CheckNameAvailability(ctx, armrelay.CheckNameAvailability{
Name: to.Ptr("example-RelayNamespace1321"),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.NamespacesClientCheckNameAvailabilityResponse{
// CheckNameAvailabilityResult: armrelay.CheckNameAvailabilityResult{
// Message: to.Ptr(""),
// NameAvailable: to.Ptr(true),
// Reason: to.Ptr(armrelay.UnavailableReasonNone),
// },
// }
}
Output:
func (*NamespacesClient) CreateOrUpdateAuthorizationRule ¶
func (client *NamespacesClient) CreateOrUpdateAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, authorizationRuleName string, parameters AuthorizationRule, options *NamespacesClientCreateOrUpdateAuthorizationRuleOptions) (NamespacesClientCreateOrUpdateAuthorizationRuleResponse, error)
CreateOrUpdateAuthorizationRule - Creates or updates an authorization rule for a namespace. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- authorizationRuleName - The authorization rule name.
- parameters - The authorization rule parameters.
- options - NamespacesClientCreateOrUpdateAuthorizationRuleOptions contains the optional parameters for the NamespacesClient.CreateOrUpdateAuthorizationRule method.
Example ¶
Generated from example definition: 2026-01-01/NameSpaces/RelayNameSpaceAuthorizationRuleCreate.json
package main
import (
"context"
"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/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNamespacesClient().CreateOrUpdateAuthorizationRule(ctx, "resourcegroup", "example-RelayNamespace-01", "example-RelayAuthRules-01", armrelay.AuthorizationRule{
Properties: &armrelay.AuthorizationRuleProperties{
Rights: []*armrelay.AccessRights{
to.Ptr(armrelay.AccessRightsListen),
to.Ptr(armrelay.AccessRightsSend),
},
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.NamespacesClientCreateOrUpdateAuthorizationRuleResponse{
// AuthorizationRule: armrelay.AuthorizationRule{
// Name: to.Ptr("example-RelayAuthRules-01"),
// Type: to.Ptr("Microsoft.Relay/Namespaces/AuthorizationRules"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/AuthorizationRules/example-RelayAuthRules-01"),
// Properties: &armrelay.AuthorizationRuleProperties{
// Rights: []*armrelay.AccessRights{
// to.Ptr(armrelay.AccessRightsListen),
// to.Ptr(armrelay.AccessRightsSend),
// },
// },
// },
// }
}
Output:
func (*NamespacesClient) CreateOrUpdateNetworkRuleSet ¶
func (client *NamespacesClient) CreateOrUpdateNetworkRuleSet(ctx context.Context, resourceGroupName string, namespaceName string, parameters NetworkRuleSet, options *NamespacesClientCreateOrUpdateNetworkRuleSetOptions) (NamespacesClientCreateOrUpdateNetworkRuleSetResponse, error)
CreateOrUpdateNetworkRuleSet - Create or update NetworkRuleSet for a Namespace. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- parameters - The Namespace IpFilterRule.
- options - NamespacesClientCreateOrUpdateNetworkRuleSetOptions contains the optional parameters for the NamespacesClient.CreateOrUpdateNetworkRuleSet method.
Example ¶
Generated from example definition: 2026-01-01/VirtualNetworkRules/RelayNetworkRuleSetCreate.json
package main
import (
"context"
"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/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("Subscription", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNamespacesClient().CreateOrUpdateNetworkRuleSet(ctx, "ResourceGroup", "example-RelayNamespace-6019", armrelay.NetworkRuleSet{
Properties: &armrelay.NetworkRuleSetProperties{
DefaultAction: to.Ptr(armrelay.DefaultActionDeny),
IPRules: []*armrelay.NWRuleSetIPRules{
{
Action: to.Ptr(armrelay.NetworkRuleIPActionAllow),
IPMask: to.Ptr("1.1.1.1"),
},
{
Action: to.Ptr(armrelay.NetworkRuleIPActionAllow),
IPMask: to.Ptr("1.1.1.2"),
},
{
Action: to.Ptr(armrelay.NetworkRuleIPActionAllow),
IPMask: to.Ptr("1.1.1.3"),
},
{
Action: to.Ptr(armrelay.NetworkRuleIPActionAllow),
IPMask: to.Ptr("1.1.1.4"),
},
{
Action: to.Ptr(armrelay.NetworkRuleIPActionAllow),
IPMask: to.Ptr("1.1.1.5"),
},
},
TrustedServiceAccessEnabled: to.Ptr(false),
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.NamespacesClientCreateOrUpdateNetworkRuleSetResponse{
// NetworkRuleSet: armrelay.NetworkRuleSet{
// Name: to.Ptr("default"),
// Type: to.Ptr("Microsoft.Relay/Namespaces/NetworkRuleSet"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroupid/providers/Microsoft.Relay/namespaces/example-RelayNamespace-9659/networkruleset/default"),
// Properties: &armrelay.NetworkRuleSetProperties{
// DefaultAction: to.Ptr(armrelay.DefaultActionDeny),
// IPRules: []*armrelay.NWRuleSetIPRules{
// {
// Action: to.Ptr(armrelay.NetworkRuleIPActionAllow),
// IPMask: to.Ptr("1.1.1.1"),
// },
// {
// Action: to.Ptr(armrelay.NetworkRuleIPActionAllow),
// IPMask: to.Ptr("1.1.1.2"),
// },
// {
// Action: to.Ptr(armrelay.NetworkRuleIPActionAllow),
// IPMask: to.Ptr("1.1.1.3"),
// },
// {
// Action: to.Ptr(armrelay.NetworkRuleIPActionAllow),
// IPMask: to.Ptr("1.1.1.4"),
// },
// {
// Action: to.Ptr(armrelay.NetworkRuleIPActionAllow),
// IPMask: to.Ptr("1.1.1.5"),
// },
// },
// TrustedServiceAccessEnabled: to.Ptr(false),
// },
// },
// }
}
Output:
func (*NamespacesClient) DeleteAuthorizationRule ¶
func (client *NamespacesClient) DeleteAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, authorizationRuleName string, options *NamespacesClientDeleteAuthorizationRuleOptions) (NamespacesClientDeleteAuthorizationRuleResponse, error)
DeleteAuthorizationRule - Deletes a namespace authorization rule. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- authorizationRuleName - The authorization rule name.
- options - NamespacesClientDeleteAuthorizationRuleOptions contains the optional parameters for the NamespacesClient.DeleteAuthorizationRule method.
Example ¶
Generated from example definition: 2026-01-01/NameSpaces/RelayNameSpaceAuthorizationRuleDelete.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNamespacesClient().DeleteAuthorizationRule(ctx, "resourcegroup", "example-RelayNamespace-01", "example-RelayAuthRules-01", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.NamespacesClientDeleteAuthorizationRuleResponse{
// }
}
Output:
func (*NamespacesClient) Get ¶
func (client *NamespacesClient) Get(ctx context.Context, resourceGroupName string, namespaceName string, options *NamespacesClientGetOptions) (NamespacesClientGetResponse, error)
Get - Returns the description for the specified namespace. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- options - NamespacesClientGetOptions contains the optional parameters for the NamespacesClient.Get method.
Example ¶
Generated from example definition: 2026-01-01/NameSpaces/RelayNameSpaceGet.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNamespacesClient().Get(ctx, "RG-eg", "example-RelayRelayNamespace-01", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.NamespacesClientGetResponse{
// Namespace: armrelay.Namespace{
// Name: to.Ptr("example-RelayRelayNamespace-01"),
// Type: to.Ptr("Microsoft.Relay/Namespaces"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG-eg/providers/Microsoft.Relay/namespaces/example-RelayRelayNamespace-01"),
// Location: to.Ptr("West US"),
// Properties: &armrelay.NamespaceProperties{
// CreatedAt: to.Ptr(time.Date(2017, time.January, 23, 20, 38, 12, 460000000, time.UTC)),
// MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:example-RelayRelayNamespace-01"),
// ProvisioningState: to.Ptr("Succeeded"),
// ServiceBusEndpoint: to.Ptr("https://example-RelayRelayNamespace-01.servicebus.windows.net:443/"),
// UpdatedAt: to.Ptr(time.Date(2017, time.January, 23, 20, 38, 34, 533000000, time.UTC)),
// MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
// },
// SKU: &armrelay.SKU{
// Name: to.Ptr(armrelay.SKUNameStandard),
// Tier: to.Ptr(armrelay.SKUTierStandard),
// },
// Tags: map[string]*string{
// "tag1": to.Ptr("value1"),
// "tag2": to.Ptr("value2"),
// },
// },
// }
}
Output:
func (*NamespacesClient) GetAuthorizationRule ¶
func (client *NamespacesClient) GetAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, authorizationRuleName string, options *NamespacesClientGetAuthorizationRuleOptions) (NamespacesClientGetAuthorizationRuleResponse, error)
GetAuthorizationRule - Authorization rule for a namespace by name. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- authorizationRuleName - The authorization rule name.
- options - NamespacesClientGetAuthorizationRuleOptions contains the optional parameters for the NamespacesClient.GetAuthorizationRule method.
Example ¶
Generated from example definition: 2026-01-01/NameSpaces/RelayNameSpaceAuthorizationRuleGet.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNamespacesClient().GetAuthorizationRule(ctx, "resourcegroup", "example-RelayNamespace-01", "example-RelayAuthRules-01", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.NamespacesClientGetAuthorizationRuleResponse{
// AuthorizationRule: armrelay.AuthorizationRule{
// Name: to.Ptr("example-RelayAuthRules-01"),
// Type: to.Ptr("Microsoft.Relay/Namespaces/AuthorizationRules"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/AuthorizationRules/example-RelayAuthRules-01"),
// Properties: &armrelay.AuthorizationRuleProperties{
// Rights: []*armrelay.AccessRights{
// to.Ptr(armrelay.AccessRightsListen),
// },
// },
// },
// }
}
Output:
func (*NamespacesClient) GetNetworkRuleSet ¶
func (client *NamespacesClient) GetNetworkRuleSet(ctx context.Context, resourceGroupName string, namespaceName string, options *NamespacesClientGetNetworkRuleSetOptions) (NamespacesClientGetNetworkRuleSetResponse, error)
GetNetworkRuleSet - Gets NetworkRuleSet for a Namespace. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- options - NamespacesClientGetNetworkRuleSetOptions contains the optional parameters for the NamespacesClient.GetNetworkRuleSet method.
Example ¶
Generated from example definition: 2026-01-01/VirtualNetworkRules/RelayNetworkRuleSetGet.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("Subscription", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNamespacesClient().GetNetworkRuleSet(ctx, "ResourceGroup", "example-RelayNamespace-6019", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.NamespacesClientGetNetworkRuleSetResponse{
// NetworkRuleSet: armrelay.NetworkRuleSet{
// Name: to.Ptr("default"),
// Type: to.Ptr("Microsoft.Relay/Namespaces/NetworkRuleSet"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroupid/providers/Microsoft.Relay/namespaces/example-RelayNamespace-9659/networkruleset/default"),
// Properties: &armrelay.NetworkRuleSetProperties{
// DefaultAction: to.Ptr(armrelay.DefaultActionDeny),
// IPRules: []*armrelay.NWRuleSetIPRules{
// {
// Action: to.Ptr(armrelay.NetworkRuleIPActionAllow),
// IPMask: to.Ptr("1.1.1.1"),
// },
// {
// Action: to.Ptr(armrelay.NetworkRuleIPActionAllow),
// IPMask: to.Ptr("1.1.1.2"),
// },
// {
// Action: to.Ptr(armrelay.NetworkRuleIPActionAllow),
// IPMask: to.Ptr("1.1.1.3"),
// },
// {
// Action: to.Ptr(armrelay.NetworkRuleIPActionAllow),
// IPMask: to.Ptr("1.1.1.4"),
// },
// {
// Action: to.Ptr(armrelay.NetworkRuleIPActionAllow),
// IPMask: to.Ptr("1.1.1.5"),
// },
// },
// TrustedServiceAccessEnabled: to.Ptr(false),
// },
// },
// }
}
Output:
func (*NamespacesClient) ListKeys ¶
func (client *NamespacesClient) ListKeys(ctx context.Context, resourceGroupName string, namespaceName string, authorizationRuleName string, options *NamespacesClientListKeysOptions) (NamespacesClientListKeysResponse, error)
ListKeys - Primary and secondary connection strings to the namespace. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- authorizationRuleName - The authorization rule name.
- options - NamespacesClientListKeysOptions contains the optional parameters for the NamespacesClient.ListKeys method.
Example ¶
Generated from example definition: 2026-01-01/NameSpaces/RelayNameSpaceAuthorizationRuleListKey.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNamespacesClient().ListKeys(ctx, "resourcegroup", "example-RelayNamespace-01", "example-RelayAuthRules-01", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.NamespacesClientListKeysResponse{
// AccessKeys: armrelay.AccessKeys{
// KeyName: to.Ptr("example-RelayAuthRules-01"),
// PrimaryConnectionString: to.Ptr("Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################"),
// PrimaryKey: to.Ptr("############################################"),
// SecondaryConnectionString: to.Ptr("Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################"),
// SecondaryKey: to.Ptr("############################################"),
// },
// }
}
Output:
func (*NamespacesClient) NewListAuthorizationRulesPager ¶
func (client *NamespacesClient) NewListAuthorizationRulesPager(resourceGroupName string, namespaceName string, options *NamespacesClientListAuthorizationRulesOptions) *runtime.Pager[NamespacesClientListAuthorizationRulesResponse]
NewListAuthorizationRulesPager - Authorization rules for a namespace.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- options - NamespacesClientListAuthorizationRulesOptions contains the optional parameters for the NamespacesClient.NewListAuthorizationRulesPager method.
Example ¶
Generated from example definition: 2026-01-01/NameSpaces/RelayNameSpaceAuthorizationRuleListAll.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewNamespacesClient().NewListAuthorizationRulesPager("resourcegroup", "example-RelayNamespace-01", 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 = armrelay.NamespacesClientListAuthorizationRulesResponse{
// AuthorizationRuleListResult: armrelay.AuthorizationRuleListResult{
// Value: []*armrelay.AuthorizationRule{
// {
// Name: to.Ptr("RootManageSharedAccessKey"),
// Type: to.Ptr("Microsoft.Relay/Namespaces/AuthorizationRules"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/AuthorizationRules/RootManageSharedAccessKey"),
// Properties: &armrelay.AuthorizationRuleProperties{
// Rights: []*armrelay.AccessRights{
// to.Ptr(armrelay.AccessRightsListen),
// to.Ptr(armrelay.AccessRightsManage),
// to.Ptr(armrelay.AccessRightsSend),
// },
// },
// },
// {
// Name: to.Ptr("example-RelayAuthRules-01"),
// Type: to.Ptr("Microsoft.Relay/Namespaces/AuthorizationRules"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/AuthorizationRules/example-RelayAuthRules-01"),
// Properties: &armrelay.AuthorizationRuleProperties{
// Rights: []*armrelay.AccessRights{
// to.Ptr(armrelay.AccessRightsListen),
// to.Ptr(armrelay.AccessRightsSend),
// },
// },
// },
// },
// },
// }
}
}
Output:
func (*NamespacesClient) NewListByResourceGroupPager ¶
func (client *NamespacesClient) NewListByResourceGroupPager(resourceGroupName string, options *NamespacesClientListByResourceGroupOptions) *runtime.Pager[NamespacesClientListByResourceGroupResponse]
NewListByResourceGroupPager - Lists all the available namespaces within the ResourceGroup.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- options - NamespacesClientListByResourceGroupOptions contains the optional parameters for the NamespacesClient.NewListByResourceGroupPager method.
Example ¶
Generated from example definition: 2026-01-01/NameSpaces/RelayNameSpaceListByResourceGroup.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewNamespacesClient().NewListByResourceGroupPager("resourcegroup", 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 = armrelay.NamespacesClientListByResourceGroupResponse{
// NamespaceListResult: armrelay.NamespaceListResult{
// Value: []*armrelay.Namespace{
// {
// Name: to.Ptr("example-RelayNamespace-3054"),
// Type: to.Ptr("Microsoft.Relay/Namespaces"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-3054"),
// Location: to.Ptr("South Central US"),
// Properties: &armrelay.NamespaceProperties{
// MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relaynamespace-3054"),
// ProvisioningState: to.Ptr("Succeeded"),
// ServiceBusEndpoint: to.Ptr("https://example-RelayNamespace-3054.servicebus.windows-int.net:443/"),
// MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
// },
// SKU: &armrelay.SKU{
// Name: to.Ptr(armrelay.SKUNameStandard),
// Tier: to.Ptr(armrelay.SKUTierStandard),
// },
// Tags: map[string]*string{
// },
// },
// {
// Name: to.Ptr("oaisdjfoiasdjfoiajsdfoijasd"),
// Type: to.Ptr("Microsoft.Relay/Namespaces"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/oaisdjfoiasdjfoiajsdfoijasd"),
// Location: to.Ptr("South Central US"),
// Properties: &armrelay.NamespaceProperties{
// MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:oaisdjfoiasdjfoiajsdfoijasd"),
// ProvisioningState: to.Ptr("Succeeded"),
// ServiceBusEndpoint: to.Ptr("https://oaisdjfoiasdjfoiajsdfoijasd.servicebus.windows-int.net:443/"),
// MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
// },
// SKU: &armrelay.SKU{
// Name: to.Ptr(armrelay.SKUNameStandard),
// Tier: to.Ptr(armrelay.SKUTierStandard),
// },
// Tags: map[string]*string{
// },
// },
// {
// Name: to.Ptr("abc123"),
// Type: to.Ptr("Microsoft.Relay/Namespaces"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/abc123"),
// Location: to.Ptr("South Central US"),
// Properties: &armrelay.NamespaceProperties{
// MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:abc123"),
// ProvisioningState: to.Ptr("Succeeded"),
// ServiceBusEndpoint: to.Ptr("https://abc123.servicebus.windows-int.net:443/"),
// MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
// },
// SKU: &armrelay.SKU{
// Name: to.Ptr(armrelay.SKUNameStandard),
// Tier: to.Ptr(armrelay.SKUTierStandard),
// },
// Tags: map[string]*string{
// },
// },
// {
// Name: to.Ptr("example-RelayNamespace-5849"),
// Type: to.Ptr("Microsoft.Relay/Namespaces"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-5849"),
// Location: to.Ptr("South Central US"),
// Properties: &armrelay.NamespaceProperties{
// MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relaynamespace-5849"),
// ProvisioningState: to.Ptr("Succeeded"),
// ServiceBusEndpoint: to.Ptr("https://example-RelayNamespace-5849.servicebus.windows-int.net:443/"),
// MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
// },
// SKU: &armrelay.SKU{
// Name: to.Ptr(armrelay.SKUNameStandard),
// Tier: to.Ptr(armrelay.SKUTierStandard),
// },
// Tags: map[string]*string{
// "tag1": to.Ptr("value1"),
// "tag2": to.Ptr("value2"),
// },
// },
// {
// Name: to.Ptr("example-RelayNamespace-4984"),
// Type: to.Ptr("Microsoft.Relay/Namespaces"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-4984"),
// Location: to.Ptr("South Central US"),
// Properties: &armrelay.NamespaceProperties{
// MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relaynamespace-4984"),
// ProvisioningState: to.Ptr("Succeeded"),
// ServiceBusEndpoint: to.Ptr("https://example-RelayNamespace-4984.servicebus.windows-int.net:443/"),
// MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
// },
// SKU: &armrelay.SKU{
// Name: to.Ptr(armrelay.SKUNameStandard),
// Tier: to.Ptr(armrelay.SKUTierStandard),
// },
// Tags: map[string]*string{
// },
// },
// {
// Name: to.Ptr("example-RelayNamespace-5606"),
// Type: to.Ptr("Microsoft.Relay/Namespaces"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-5606"),
// Location: to.Ptr("South Central US"),
// Properties: &armrelay.NamespaceProperties{
// MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relaynamespace-5606"),
// ProvisioningState: to.Ptr("Succeeded"),
// ServiceBusEndpoint: to.Ptr("https://example-RelayNamespace-5606.servicebus.windows-int.net:443/"),
// MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
// },
// SKU: &armrelay.SKU{
// Name: to.Ptr(armrelay.SKUNameStandard),
// Tier: to.Ptr(armrelay.SKUTierStandard),
// },
// Tags: map[string]*string{
// },
// },
// {
// Name: to.Ptr("example-RelayNamespace-7703"),
// Type: to.Ptr("Microsoft.Relay/Namespaces"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-7703"),
// Location: to.Ptr("South Central US"),
// Properties: &armrelay.NamespaceProperties{
// MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relaynamespace-7703"),
// ProvisioningState: to.Ptr("Succeeded"),
// ServiceBusEndpoint: to.Ptr("https://example-RelayNamespace-7703.servicebus.windows-int.net:443/"),
// MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
// },
// SKU: &armrelay.SKU{
// Name: to.Ptr(armrelay.SKUNameStandard),
// Tier: to.Ptr(armrelay.SKUTierStandard),
// },
// Tags: map[string]*string{
// },
// },
// {
// Name: to.Ptr("zzzzzzzzzzzzzzzzzzzzzz-00001"),
// Type: to.Ptr("Microsoft.Relay/Namespaces"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/zzzzzzzzzzzzzzzzzzzzzz-00001"),
// Location: to.Ptr("South Central US"),
// Properties: &armrelay.NamespaceProperties{
// MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:zzzzzzzzzzzzzzzzzzzzzz-00001"),
// ProvisioningState: to.Ptr("Succeeded"),
// ServiceBusEndpoint: to.Ptr("https://zzzzzzzzzzzzzzzzzzzzzz-00001.servicebus.windows-int.net:443/"),
// MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
// },
// SKU: &armrelay.SKU{
// Name: to.Ptr(armrelay.SKUNameStandard),
// Tier: to.Ptr(armrelay.SKUTierStandard),
// },
// Tags: map[string]*string{
// },
// },
// {
// Name: to.Ptr("example-RelayNamespace-3919"),
// Type: to.Ptr("Microsoft.Relay/Namespaces"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-3919"),
// Location: to.Ptr("South Central US"),
// Properties: &armrelay.NamespaceProperties{
// MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relaynamespace-3919"),
// ProvisioningState: to.Ptr("Succeeded"),
// ServiceBusEndpoint: to.Ptr("https://example-RelayNamespace-3919.servicebus.windows-int.net:443/"),
// MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
// },
// SKU: &armrelay.SKU{
// Name: to.Ptr(armrelay.SKUNameStandard),
// Tier: to.Ptr(armrelay.SKUTierStandard),
// },
// Tags: map[string]*string{
// },
// },
// {
// Name: to.Ptr("aiosdjfaoidjasdoijasdfoijasdfofijsdf"),
// Type: to.Ptr("Microsoft.Relay/Namespaces"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/aiosdjfaoidjasdoijasdfoijasdfofijsdf"),
// Location: to.Ptr("South Central US"),
// Properties: &armrelay.NamespaceProperties{
// MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:aiosdjfaoidjasdoijasdfoijasdfofijsdf"),
// ProvisioningState: to.Ptr("Succeeded"),
// ServiceBusEndpoint: to.Ptr("https://aiosdjfaoidjasdoijasdfoijasdfofijsdf.servicebus.windows-int.net:443/"),
// MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
// },
// SKU: &armrelay.SKU{
// Name: to.Ptr(armrelay.SKUNameStandard),
// Tier: to.Ptr(armrelay.SKUTierStandard),
// },
// Tags: map[string]*string{
// },
// },
// {
// Name: to.Ptr("example-RelayNamespace-3413"),
// Type: to.Ptr("Microsoft.Relay/Namespaces"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-3413"),
// Location: to.Ptr("South Central US"),
// Properties: &armrelay.NamespaceProperties{
// MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relaynamespace-3413"),
// ProvisioningState: to.Ptr("Succeeded"),
// ServiceBusEndpoint: to.Ptr("https://example-RelayNamespace-3413.servicebus.windows-int.net:443/"),
// MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
// },
// SKU: &armrelay.SKU{
// Name: to.Ptr(armrelay.SKUNameStandard),
// Tier: to.Ptr(armrelay.SKUTierStandard),
// },
// Tags: map[string]*string{
// },
// },
// {
// Name: to.Ptr("example-RelayNamespace-8695"),
// Type: to.Ptr("Microsoft.Relay/Namespaces"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-8695"),
// Location: to.Ptr("South Central US"),
// Properties: &armrelay.NamespaceProperties{
// MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relaynamespace-8695"),
// ProvisioningState: to.Ptr("Succeeded"),
// ServiceBusEndpoint: to.Ptr("https://example-RelayNamespace-8695.servicebus.windows-int.net:443/"),
// MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
// },
// SKU: &armrelay.SKU{
// Name: to.Ptr(armrelay.SKUNameStandard),
// Tier: to.Ptr(armrelay.SKUTierStandard),
// },
// Tags: map[string]*string{
// },
// },
// {
// Name: to.Ptr("example-RelayNamespace-4801"),
// Type: to.Ptr("Microsoft.Relay/Namespaces"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-4801"),
// Location: to.Ptr("South Central US"),
// Properties: &armrelay.NamespaceProperties{
// MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relaynamespace-4801"),
// ProvisioningState: to.Ptr("Succeeded"),
// ServiceBusEndpoint: to.Ptr("https://example-RelayNamespace-4801.servicebus.windows-int.net:443/"),
// MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
// },
// SKU: &armrelay.SKU{
// Name: to.Ptr(armrelay.SKUNameStandard),
// Tier: to.Ptr(armrelay.SKUTierStandard),
// },
// Tags: map[string]*string{
// },
// },
// {
// Name: to.Ptr("example-RelayNamespace-2812"),
// Type: to.Ptr("Microsoft.Relay/Namespaces"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-2812"),
// Location: to.Ptr("South Central US"),
// Properties: &armrelay.NamespaceProperties{
// MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relaynamespace-2812"),
// ProvisioningState: to.Ptr("Succeeded"),
// ServiceBusEndpoint: to.Ptr("https://example-RelayNamespace-2812.servicebus.windows-int.net:443/"),
// MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
// },
// SKU: &armrelay.SKU{
// Name: to.Ptr(armrelay.SKUNameStandard),
// Tier: to.Ptr(armrelay.SKUTierStandard),
// },
// Tags: map[string]*string{
// },
// },
// },
// },
// }
}
}
Output:
func (*NamespacesClient) NewListPager ¶
func (client *NamespacesClient) NewListPager(options *NamespacesClientListOptions) *runtime.Pager[NamespacesClientListResponse]
NewListPager - Lists all the available namespaces within the subscription regardless of the resourceGroups.
- options - NamespacesClientListOptions contains the optional parameters for the NamespacesClient.NewListPager method.
Example ¶
Generated from example definition: 2026-01-01/NameSpaces/RelayNameSpaceListBySubscription.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewNamespacesClient().NewListPager(nil)
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page = armrelay.NamespacesClientListResponse{
// NamespaceListResult: armrelay.NamespaceListResult{
// Value: []*armrelay.Namespace{
// {
// Name: to.Ptr("example-RelayRelayNamespace-01"),
// Type: to.Ptr("Microsoft.Relay/Namespaces"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG1-eg/providers/Microsoft.Relay/namespaces/example-RelayRelayNamespace-01"),
// Location: to.Ptr("West US"),
// Properties: &armrelay.NamespaceProperties{
// CreatedAt: to.Ptr(time.Date(2017, time.January, 23, 20, 34, 49, 413172400, time.UTC)),
// MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:example-RelayRelayNamespace-01"),
// ProvisioningState: to.Ptr("Succeeded"),
// ServiceBusEndpoint: to.Ptr("https://example-RelayRelayNamespace-01.servicebus.windows.net:443/"),
// UpdatedAt: to.Ptr(time.Date(2017, time.January, 23, 20, 34, 59, 413172400, time.UTC)),
// MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
// },
// SKU: &armrelay.SKU{
// Name: to.Ptr(armrelay.SKUNameStandard),
// Tier: to.Ptr(armrelay.SKUTierStandard),
// },
// Tags: map[string]*string{
// "tag1": to.Ptr("value1"),
// "tag2": to.Ptr("value2"),
// },
// },
// {
// Name: to.Ptr("example-RelayRelayNamespace-02"),
// Type: to.Ptr("Microsoft.Relay/Namespaces"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG1-eg/providers/Microsoft.Relay/namespaces/example-RelayRelayNamespace-02"),
// Location: to.Ptr("West US"),
// Properties: &armrelay.NamespaceProperties{
// CreatedAt: to.Ptr(time.Date(2017, time.January, 23, 20, 34, 39, 413172400, time.UTC)),
// MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:example-RelayRelayNamespace-02"),
// ProvisioningState: to.Ptr("Succeeded"),
// ServiceBusEndpoint: to.Ptr("https://example-RelayRelayNamespace-02.servicebus.windows.net:443/"),
// UpdatedAt: to.Ptr(time.Date(2017, time.January, 23, 20, 34, 49, 413172400, time.UTC)),
// MinimumTLSVersion: to.Ptr(armrelay.TLSVersion12),
// },
// SKU: &armrelay.SKU{
// Name: to.Ptr(armrelay.SKUNameStandard),
// Tier: to.Ptr(armrelay.SKUTierStandard),
// },
// Tags: map[string]*string{
// "tag1": to.Ptr("value1"),
// "tag2": to.Ptr("value2"),
// },
// },
// },
// },
// }
}
}
Output:
func (*NamespacesClient) RegenerateKeys ¶
func (client *NamespacesClient) RegenerateKeys(ctx context.Context, resourceGroupName string, namespaceName string, authorizationRuleName string, parameters RegenerateAccessKeyParameters, options *NamespacesClientRegenerateKeysOptions) (NamespacesClientRegenerateKeysResponse, error)
RegenerateKeys - Regenerates the primary or secondary connection strings to the namespace. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- authorizationRuleName - The authorization rule name.
- parameters - Parameters supplied to regenerate authorization rule.
- options - NamespacesClientRegenerateKeysOptions contains the optional parameters for the NamespacesClient.RegenerateKeys method.
Example ¶
Generated from example definition: 2026-01-01/NameSpaces/RelayNameSpaceAuthorizationRuleRegenerateKey.json
package main
import (
"context"
"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/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNamespacesClient().RegenerateKeys(ctx, "resourcegroup", "example-RelayNamespace-01", "example-RelayAuthRules-01", armrelay.RegenerateAccessKeyParameters{
KeyType: to.Ptr(armrelay.KeyTypePrimaryKey),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.NamespacesClientRegenerateKeysResponse{
// AccessKeys: armrelay.AccessKeys{
// KeyName: to.Ptr("example-RelayAuthRules-01"),
// PrimaryConnectionString: to.Ptr("Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################"),
// PrimaryKey: to.Ptr("############################################"),
// SecondaryConnectionString: to.Ptr("Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################"),
// SecondaryKey: to.Ptr("############################################"),
// },
// }
}
Output:
func (*NamespacesClient) Update ¶
func (client *NamespacesClient) Update(ctx context.Context, resourceGroupName string, namespaceName string, parameters UpdateParameters, options *NamespacesClientUpdateOptions) (NamespacesClientUpdateResponse, error)
Update - Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- parameters - Parameters for updating a namespace resource.
- options - NamespacesClientUpdateOptions contains the optional parameters for the NamespacesClient.Update method.
Example ¶
Generated from example definition: 2026-01-01/NameSpaces/RelayNameSpaceUpdate.json
package main
import (
"context"
"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/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNamespacesClient().Update(ctx, "RG-eg", "example-RelayRelayNamespace-01", armrelay.UpdateParameters{
Tags: map[string]*string{
"tag3": to.Ptr("value3"),
"tag4": to.Ptr("value4"),
"tag5": to.Ptr("value5"),
"tag6": to.Ptr("value6"),
},
Properties: &armrelay.NamespaceProperties{
MinimumTLSVersion: to.Ptr(armrelay.TLSVersion13),
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.NamespacesClientUpdateResponse{
// Namespace: armrelay.Namespace{
// Name: to.Ptr("example-RelayRelayNamespace-01"),
// Type: to.Ptr("Microsoft.Relay/Namespaces"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG-eg/providers/Microsoft.Relay/namespaces/example-RelayRelayNamespace-01"),
// Location: to.Ptr("West US"),
// Properties: &armrelay.NamespaceProperties{
// MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relayrelaynamespace-01"),
// ProvisioningState: to.Ptr("Succeeded"),
// MinimumTLSVersion: to.Ptr(armrelay.TLSVersion13),
// },
// Tags: map[string]*string{
// "tag3": to.Ptr("value3"),
// "tag4": to.Ptr("value4"),
// "tag5": to.Ptr("value5"),
// "tag6": to.Ptr("value6"),
// },
// },
// }
}
Output:
type NamespacesClientBeginCreateOrUpdateOptions ¶
type NamespacesClientBeginCreateOrUpdateOptions struct {
// Resumes the long-running operation from the provided token.
ResumeToken string
}
NamespacesClientBeginCreateOrUpdateOptions contains the optional parameters for the NamespacesClient.BeginCreateOrUpdate method.
type NamespacesClientBeginDeleteOptions ¶
type NamespacesClientBeginDeleteOptions struct {
// Resumes the long-running operation from the provided token.
ResumeToken string
}
NamespacesClientBeginDeleteOptions contains the optional parameters for the NamespacesClient.BeginDelete method.
type NamespacesClientCheckNameAvailabilityOptions ¶
type NamespacesClientCheckNameAvailabilityOptions struct {
}
NamespacesClientCheckNameAvailabilityOptions contains the optional parameters for the NamespacesClient.CheckNameAvailability method.
type NamespacesClientCheckNameAvailabilityResponse ¶
type NamespacesClientCheckNameAvailabilityResponse struct {
// Description of the check name availability request properties.
CheckNameAvailabilityResult
}
NamespacesClientCheckNameAvailabilityResponse contains the response from method NamespacesClient.CheckNameAvailability.
type NamespacesClientCreateOrUpdateAuthorizationRuleOptions ¶
type NamespacesClientCreateOrUpdateAuthorizationRuleOptions struct {
}
NamespacesClientCreateOrUpdateAuthorizationRuleOptions contains the optional parameters for the NamespacesClient.CreateOrUpdateAuthorizationRule method.
type NamespacesClientCreateOrUpdateAuthorizationRuleResponse ¶
type NamespacesClientCreateOrUpdateAuthorizationRuleResponse struct {
// Single item in a List or Get AuthorizationRule operation
AuthorizationRule
}
NamespacesClientCreateOrUpdateAuthorizationRuleResponse contains the response from method NamespacesClient.CreateOrUpdateAuthorizationRule.
type NamespacesClientCreateOrUpdateNetworkRuleSetOptions ¶
type NamespacesClientCreateOrUpdateNetworkRuleSetOptions struct {
}
NamespacesClientCreateOrUpdateNetworkRuleSetOptions contains the optional parameters for the NamespacesClient.CreateOrUpdateNetworkRuleSet method.
type NamespacesClientCreateOrUpdateNetworkRuleSetResponse ¶
type NamespacesClientCreateOrUpdateNetworkRuleSetResponse struct {
// Description of topic resource.
NetworkRuleSet
}
NamespacesClientCreateOrUpdateNetworkRuleSetResponse contains the response from method NamespacesClient.CreateOrUpdateNetworkRuleSet.
type NamespacesClientCreateOrUpdateResponse ¶
type NamespacesClientCreateOrUpdateResponse struct {
// Description of a namespace resource.
Namespace
}
NamespacesClientCreateOrUpdateResponse contains the response from method NamespacesClient.BeginCreateOrUpdate.
type NamespacesClientDeleteAuthorizationRuleOptions ¶
type NamespacesClientDeleteAuthorizationRuleOptions struct {
}
NamespacesClientDeleteAuthorizationRuleOptions contains the optional parameters for the NamespacesClient.DeleteAuthorizationRule method.
type NamespacesClientDeleteAuthorizationRuleResponse ¶
type NamespacesClientDeleteAuthorizationRuleResponse struct {
}
NamespacesClientDeleteAuthorizationRuleResponse contains the response from method NamespacesClient.DeleteAuthorizationRule.
type NamespacesClientDeleteResponse ¶
type NamespacesClientDeleteResponse struct {
}
NamespacesClientDeleteResponse contains the response from method NamespacesClient.BeginDelete.
type NamespacesClientGetAuthorizationRuleOptions ¶
type NamespacesClientGetAuthorizationRuleOptions struct {
}
NamespacesClientGetAuthorizationRuleOptions contains the optional parameters for the NamespacesClient.GetAuthorizationRule method.
type NamespacesClientGetAuthorizationRuleResponse ¶
type NamespacesClientGetAuthorizationRuleResponse struct {
// Single item in a List or Get AuthorizationRule operation
AuthorizationRule
}
NamespacesClientGetAuthorizationRuleResponse contains the response from method NamespacesClient.GetAuthorizationRule.
type NamespacesClientGetNetworkRuleSetOptions ¶
type NamespacesClientGetNetworkRuleSetOptions struct {
}
NamespacesClientGetNetworkRuleSetOptions contains the optional parameters for the NamespacesClient.GetNetworkRuleSet method.
type NamespacesClientGetNetworkRuleSetResponse ¶
type NamespacesClientGetNetworkRuleSetResponse struct {
// Description of topic resource.
NetworkRuleSet
}
NamespacesClientGetNetworkRuleSetResponse contains the response from method NamespacesClient.GetNetworkRuleSet.
type NamespacesClientGetOptions ¶
type NamespacesClientGetOptions struct {
}
NamespacesClientGetOptions contains the optional parameters for the NamespacesClient.Get method.
type NamespacesClientGetResponse ¶
type NamespacesClientGetResponse struct {
// Description of a namespace resource.
Namespace
}
NamespacesClientGetResponse contains the response from method NamespacesClient.Get.
type NamespacesClientListAuthorizationRulesOptions ¶
type NamespacesClientListAuthorizationRulesOptions struct {
}
NamespacesClientListAuthorizationRulesOptions contains the optional parameters for the NamespacesClient.NewListAuthorizationRulesPager method.
type NamespacesClientListAuthorizationRulesResponse ¶
type NamespacesClientListAuthorizationRulesResponse struct {
// The response of a AuthorizationRule list operation.
AuthorizationRuleListResult
}
NamespacesClientListAuthorizationRulesResponse contains the response from method NamespacesClient.NewListAuthorizationRulesPager.
type NamespacesClientListByResourceGroupOptions ¶
type NamespacesClientListByResourceGroupOptions struct {
}
NamespacesClientListByResourceGroupOptions contains the optional parameters for the NamespacesClient.NewListByResourceGroupPager method.
type NamespacesClientListByResourceGroupResponse ¶
type NamespacesClientListByResourceGroupResponse struct {
// The response of a RelayNamespace list operation.
NamespaceListResult
}
NamespacesClientListByResourceGroupResponse contains the response from method NamespacesClient.NewListByResourceGroupPager.
type NamespacesClientListKeysOptions ¶
type NamespacesClientListKeysOptions struct {
}
NamespacesClientListKeysOptions contains the optional parameters for the NamespacesClient.ListKeys method.
type NamespacesClientListKeysResponse ¶
type NamespacesClientListKeysResponse struct {
// Namespace/Relay Connection String
AccessKeys
}
NamespacesClientListKeysResponse contains the response from method NamespacesClient.ListKeys.
type NamespacesClientListOptions ¶
type NamespacesClientListOptions struct {
}
NamespacesClientListOptions contains the optional parameters for the NamespacesClient.NewListPager method.
type NamespacesClientListResponse ¶
type NamespacesClientListResponse struct {
// The response of a RelayNamespace list operation.
NamespaceListResult
}
NamespacesClientListResponse contains the response from method NamespacesClient.NewListPager.
type NamespacesClientRegenerateKeysOptions ¶
type NamespacesClientRegenerateKeysOptions struct {
}
NamespacesClientRegenerateKeysOptions contains the optional parameters for the NamespacesClient.RegenerateKeys method.
type NamespacesClientRegenerateKeysResponse ¶
type NamespacesClientRegenerateKeysResponse struct {
// Namespace/Relay Connection String
AccessKeys
}
NamespacesClientRegenerateKeysResponse contains the response from method NamespacesClient.RegenerateKeys.
type NamespacesClientUpdateOptions ¶
type NamespacesClientUpdateOptions struct {
}
NamespacesClientUpdateOptions contains the optional parameters for the NamespacesClient.Update method.
type NamespacesClientUpdateResponse ¶
type NamespacesClientUpdateResponse struct {
// Description of a namespace resource.
Namespace
}
NamespacesClientUpdateResponse contains the response from method NamespacesClient.Update.
type NetworkRuleIPAction ¶
type NetworkRuleIPAction string
NetworkRuleIPAction - The IP Filter Action
const (
NetworkRuleIPActionAllow NetworkRuleIPAction = "Allow"
)
func PossibleNetworkRuleIPActionValues ¶
func PossibleNetworkRuleIPActionValues() []NetworkRuleIPAction
PossibleNetworkRuleIPActionValues returns the possible values for the NetworkRuleIPAction const type.
type NetworkRuleSet ¶
type NetworkRuleSet struct {
// NetworkRuleSet properties
Properties *NetworkRuleSetProperties
// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ID *string
// READ-ONLY; The name of the resource
Name *string
// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
SystemData *SystemData
// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string
}
NetworkRuleSet - Description of topic resource.
func (NetworkRuleSet) MarshalJSON ¶
func (n NetworkRuleSet) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type NetworkRuleSet.
func (*NetworkRuleSet) UnmarshalJSON ¶
func (n *NetworkRuleSet) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type NetworkRuleSet.
type NetworkRuleSetProperties ¶
type NetworkRuleSetProperties struct {
// Default Action for Network Rule Set
DefaultAction *DefaultAction
// List of IpRules
IPRules []*NWRuleSetIPRules
// This determines if traffic is allowed over public network. By default it is enabled
PublicNetworkAccess *PublicNetworkAccess
// Value that indicates whether Trusted Service Access is Enabled or not.
TrustedServiceAccessEnabled *bool
}
NetworkRuleSetProperties - NetworkRuleSet properties
func (NetworkRuleSetProperties) MarshalJSON ¶
func (n NetworkRuleSetProperties) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type NetworkRuleSetProperties.
func (*NetworkRuleSetProperties) UnmarshalJSON ¶
func (n *NetworkRuleSetProperties) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type NetworkRuleSetProperties.
type Operation ¶
type Operation struct {
// Localized display information for this particular operation.
Display *OperationDisplay
// READ-ONLY; Extensible 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 Azure
// Resource Manager/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 - REST API Operation
Details of a REST API operation, returned from the Resource Provider Operations API
func (Operation) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type Operation.
func (*Operation) UnmarshalJSON ¶
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 an operation.
func (OperationDisplay) MarshalJSON ¶
func (o OperationDisplay) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type OperationDisplay.
func (*OperationDisplay) UnmarshalJSON ¶
func (o *OperationDisplay) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type OperationDisplay.
type OperationListResult ¶
type OperationListResult struct {
// REQUIRED; The Operation items on this page
Value []*Operation
// The link to the next page of items
NextLink *string
}
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 ¶
func (o *OperationListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type OperationListResult.
type OperationsClient ¶
type OperationsClient struct {
// contains filtered or unexported fields
}
OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.
Generated from API version 2026-01-01
func NewOperationsClient ¶
func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)
NewOperationsClient creates a new instance of OperationsClient with the specified values.
- credential - used to authorize requests. Usually a credential from azidentity.
- options - Contains optional client configuration. Pass nil to accept the default values.
func (*OperationsClient) NewListPager ¶
func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]
NewListPager - List the operations for the provider
- options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
Example ¶
Generated from example definition: 2026-01-01/RelayOperations_List.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewOperationsClient().NewListPager(nil)
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page = armrelay.OperationsClientListResponse{
// OperationListResult: armrelay.OperationListResult{
// Value: []*armrelay.Operation{
// {
// Name: to.Ptr("Microsoft.Relay/checkNameAvailability/action"),
// Display: &armrelay.OperationDisplay{
// Operation: to.Ptr("Get namespace availability."),
// Provider: to.Ptr("Microsoft Azure Relay"),
// Resource: to.Ptr("Non Resource Operation"),
// },
// },
// {
// Name: to.Ptr("Microsoft.Relay/register/action"),
// Display: &armrelay.OperationDisplay{
// Operation: to.Ptr("Registers the Relay Resource Provider"),
// Provider: to.Ptr("Microsoft Azure Relay"),
// Resource: to.Ptr("Relay Resource Provider"),
// },
// },
// {
// Name: to.Ptr("Microsoft.Relay/namespaces/write"),
// Display: &armrelay.OperationDisplay{
// Operation: to.Ptr("Create Or Update Namespace "),
// Provider: to.Ptr("Microsoft Azure Relay"),
// Resource: to.Ptr("Namespace"),
// },
// },
// {
// Name: to.Ptr("Microsoft.Relay/namespaces/read"),
// Display: &armrelay.OperationDisplay{
// Operation: to.Ptr("Get Namespace Resource"),
// Provider: to.Ptr("Microsoft Azure Relay"),
// Resource: to.Ptr("Namespace"),
// },
// },
// {
// Name: to.Ptr("Microsoft.Relay/namespaces/Delete"),
// Display: &armrelay.OperationDisplay{
// Operation: to.Ptr("Delete Namespace"),
// Provider: to.Ptr("Microsoft Azure Relay"),
// Resource: to.Ptr("Namespace"),
// },
// },
// {
// Name: to.Ptr("Microsoft.Relay/namespaces/Relays/write"),
// Display: &armrelay.OperationDisplay{
// Operation: to.Ptr("Create or Update Relay"),
// Provider: to.Ptr("Microsoft Azure Relay"),
// Resource: to.Ptr("Relay"),
// },
// },
// {
// Name: to.Ptr("Microsoft.Relay/namespaces/Relays/read"),
// Display: &armrelay.OperationDisplay{
// Operation: to.Ptr("Get Relay"),
// Provider: to.Ptr("Microsoft Azure Relay"),
// Resource: to.Ptr("Relay"),
// },
// },
// {
// Name: to.Ptr("Microsoft.Relay/namespaces/Relays/Delete"),
// Display: &armrelay.OperationDisplay{
// Operation: to.Ptr("Delete Relay"),
// Provider: to.Ptr("Microsoft Azure Relay"),
// Resource: to.Ptr("Relay"),
// },
// },
// {
// Name: to.Ptr("Microsoft.Relay/namespaces/metricDefinitions/read"),
// Display: &armrelay.OperationDisplay{
// Operation: to.Ptr("Get Namespace metrics"),
// Provider: to.Ptr("Microsoft Azure Relay"),
// Resource: to.Ptr("Namespace metrics"),
// },
// },
// {
// Name: to.Ptr("Microsoft.Relay/namespaces/diagnosticSettings/read"),
// Display: &armrelay.OperationDisplay{
// Operation: to.Ptr("Get Namespace diagnostic settings"),
// Provider: to.Ptr("Microsoft Azure Relay"),
// Resource: to.Ptr("Namespace diagnostic settings"),
// },
// },
// {
// Name: to.Ptr("Microsoft.Relay/namespaces/diagnosticSettings/write"),
// Display: &armrelay.OperationDisplay{
// Operation: to.Ptr("Create or Update Namespace diagnostic settings"),
// Provider: to.Ptr("Microsoft Azure Relay"),
// Resource: to.Ptr("Namespace diagnostic settings"),
// },
// },
// {
// Name: to.Ptr("Microsoft.Relay/namespaces/logDefinitions/read"),
// Display: &armrelay.OperationDisplay{
// Operation: to.Ptr("Get Namespace logs"),
// Provider: to.Ptr("Microsoft Azure Relay"),
// Resource: to.Ptr("Namespace logs"),
// },
// },
// },
// },
// }
}
}
Output:
type OperationsClientListOptions ¶
type OperationsClientListOptions struct {
}
OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
type OperationsClientListResponse ¶
type OperationsClientListResponse 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
}
OperationsClientListResponse contains the response from method OperationsClient.NewListPager.
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"
const ( // OriginSystem - Indicates the operation is initiated by a system. OriginSystem Origin = "system" // OriginUser - Indicates the operation is initiated by a user. OriginUser Origin = "user" // OriginUserSystem - Indicates the operation is initiated by a user or system. OriginUserSystem Origin = "user,system" )
func PossibleOriginValues ¶
func PossibleOriginValues() []Origin
PossibleOriginValues returns the possible values for the Origin const type.
type PrivateEndpoint ¶
type PrivateEndpoint struct {
// The ARM identifier for Private Endpoint.
ID *string
}
PrivateEndpoint information.
func (PrivateEndpoint) MarshalJSON ¶
func (p PrivateEndpoint) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type PrivateEndpoint.
func (*PrivateEndpoint) UnmarshalJSON ¶
func (p *PrivateEndpoint) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpoint.
type PrivateEndpointConnection ¶
type PrivateEndpointConnection struct {
// Properties of the PrivateEndpointConnection.
Properties *PrivateEndpointConnectionProperties
// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ID *string
// READ-ONLY; The geo-location where the resource lives
Location *string
// READ-ONLY; The name of the resource
Name *string
// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
SystemData *SystemData
// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string
}
PrivateEndpointConnection - Properties of the PrivateEndpointConnection.
func (PrivateEndpointConnection) MarshalJSON ¶
func (p PrivateEndpointConnection) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnection.
func (*PrivateEndpointConnection) UnmarshalJSON ¶
func (p *PrivateEndpointConnection) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnection.
type PrivateEndpointConnectionListResult ¶
type PrivateEndpointConnectionListResult struct {
// REQUIRED; The PrivateEndpointConnection items on this page
Value []*PrivateEndpointConnection
// The link to the next page of items
NextLink *string
}
PrivateEndpointConnectionListResult - The response of a PrivateEndpointConnection list operation.
func (PrivateEndpointConnectionListResult) MarshalJSON ¶
func (p PrivateEndpointConnectionListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionListResult.
func (*PrivateEndpointConnectionListResult) UnmarshalJSON ¶
func (p *PrivateEndpointConnectionListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionListResult.
type PrivateEndpointConnectionProperties ¶
type PrivateEndpointConnectionProperties struct {
// The Private Endpoint resource for this Connection.
PrivateEndpoint *PrivateEndpoint
// Details about the state of the connection.
PrivateLinkServiceConnectionState *ConnectionState
// Provisioning state of the Private Endpoint Connection.
ProvisioningState *EndPointProvisioningState
}
PrivateEndpointConnectionProperties - Properties of the private endpoint connection resource.
func (PrivateEndpointConnectionProperties) MarshalJSON ¶
func (p PrivateEndpointConnectionProperties) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionProperties.
func (*PrivateEndpointConnectionProperties) UnmarshalJSON ¶
func (p *PrivateEndpointConnectionProperties) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionProperties.
type PrivateEndpointConnectionsClient ¶
type PrivateEndpointConnectionsClient struct {
// contains filtered or unexported fields
}
PrivateEndpointConnectionsClient contains the methods for the PrivateEndpointConnections group. Don't use this type directly, use NewPrivateEndpointConnectionsClient() instead.
Generated from API version 2026-01-01
func NewPrivateEndpointConnectionsClient ¶
func NewPrivateEndpointConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateEndpointConnectionsClient, error)
NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient with the specified values.
- subscriptionID - The ID of the target subscription. The value must be an UUID.
- credential - used to authorize requests. Usually a credential from azidentity.
- options - Contains optional client configuration. Pass nil to accept the default values.
func (*PrivateEndpointConnectionsClient) BeginDelete ¶
func (client *PrivateEndpointConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, namespaceName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientBeginDeleteOptions) (*runtime.Poller[PrivateEndpointConnectionsClientDeleteResponse], error)
BeginDelete - Deletes an existing namespace. This operation also removes all associated resources under the namespace. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- privateEndpointConnectionName - The PrivateEndpointConnection name
- options - PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.
Example ¶
Generated from example definition: 2026-01-01/PrivateEndpointConnections/PrivateEndpointConnectionsDelete.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPrivateEndpointConnectionsClient().BeginDelete(ctx, "myResourceGroup", "example-RelayNamespace-5849", "{privateEndpointConnection name}", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to poll the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.PrivateEndpointConnectionsClientDeleteResponse{
// }
}
Output:
func (*PrivateEndpointConnectionsClient) CreateOrUpdate ¶
func (client *PrivateEndpointConnectionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, namespaceName string, privateEndpointConnectionName string, parameters PrivateEndpointConnection, options *PrivateEndpointConnectionsClientCreateOrUpdateOptions) (PrivateEndpointConnectionsClientCreateOrUpdateResponse, error)
CreateOrUpdate - Creates or updates PrivateEndpointConnections of service namespace. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- privateEndpointConnectionName - The PrivateEndpointConnection name
- parameters - Parameters supplied to update Status of PrivateEndPoint Connection to namespace resource.
- options - PrivateEndpointConnectionsClientCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.CreateOrUpdate method.
Example ¶
Generated from example definition: 2026-01-01/PrivateEndpointConnections/PrivateEndpointConnectionsCreate.json
package main
import (
"context"
"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/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateEndpointConnectionsClient().CreateOrUpdate(ctx, "resourcegroup", "example-RelayNamespace-5849", "{privateEndpointConnection name}", armrelay.PrivateEndpointConnection{
Properties: &armrelay.PrivateEndpointConnectionProperties{
PrivateEndpoint: &armrelay.PrivateEndpoint{
ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Network/privateEndpoints/ali-relay-pve-1"),
},
PrivateLinkServiceConnectionState: &armrelay.ConnectionState{
Description: to.Ptr("You may pass"),
Status: to.Ptr(armrelay.PrivateLinkConnectionStatusApproved),
},
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.PrivateEndpointConnectionsClientCreateOrUpdateResponse{
// PrivateEndpointConnection: armrelay.PrivateEndpointConnection{
// Name: to.Ptr("{privateEndpointConnection name}"),
// Type: to.Ptr("Microsoft.Relay/Namespaces/PrivateEndpointConnections"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/alitest/providers/Microsoft.Relay/namespaces/relay-private-endpoint-test/privateEndpointConnections/{privateEndpointConnection name}"),
// Location: to.Ptr("South Central US"),
// Properties: &armrelay.PrivateEndpointConnectionProperties{
// PrivateEndpoint: &armrelay.PrivateEndpoint{
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Network/privateEndpoints/ali-relay-pve-1"),
// },
// PrivateLinkServiceConnectionState: &armrelay.ConnectionState{
// Description: to.Ptr("You may pass"),
// Status: to.Ptr(armrelay.PrivateLinkConnectionStatusApproved),
// },
// ProvisioningState: to.Ptr(armrelay.EndPointProvisioningStateUpdating),
// },
// },
// }
}
Output:
func (*PrivateEndpointConnectionsClient) Get ¶
func (client *PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, namespaceName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientGetOptions) (PrivateEndpointConnectionsClientGetResponse, error)
Get - Gets a description for the specified Private Endpoint Connection name. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- privateEndpointConnectionName - The PrivateEndpointConnection name
- options - PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.
Example ¶
Generated from example definition: 2026-01-01/PrivateEndpointConnections/PrivateEndpointConnectionsGet.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateEndpointConnectionsClient().Get(ctx, "myResourceGroup", "example-RelayNamespace-5849", "{privateEndpointConnection name}", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.PrivateEndpointConnectionsClientGetResponse{
// PrivateEndpointConnection: armrelay.PrivateEndpointConnection{
// Name: to.Ptr("{privateEndpointConnection name}"),
// Type: to.Ptr("Microsoft.Relay/Namespaces/PrivateEndpointConnections"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/{RGName}/providers/Microsoft.Relay/namespaces/relay-private-endpoint-test/privateEndpointConnections/{privateEndpointConnection name}"),
// Location: to.Ptr("South Central US"),
// Properties: &armrelay.PrivateEndpointConnectionProperties{
// PrivateEndpoint: &armrelay.PrivateEndpoint{
// ID: to.Ptr("/subscriptions/326100e2-f69d-4268-8503-075374f62b6e/resourceGroups/resourcegroup/providers/Microsoft.Network/privateEndpoints/ali-relay-pve-1"),
// },
// PrivateLinkServiceConnectionState: &armrelay.ConnectionState{
// Description: to.Ptr("approve please"),
// Status: to.Ptr(armrelay.PrivateLinkConnectionStatusPending),
// },
// ProvisioningState: to.Ptr(armrelay.EndPointProvisioningStateSucceeded),
// },
// },
// }
}
Output:
func (*PrivateEndpointConnectionsClient) NewListPager ¶
func (client *PrivateEndpointConnectionsClient) NewListPager(resourceGroupName string, namespaceName string, options *PrivateEndpointConnectionsClientListOptions) *runtime.Pager[PrivateEndpointConnectionsClientListResponse]
NewListPager - Gets the available PrivateEndpointConnections within a namespace.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- options - PrivateEndpointConnectionsClientListOptions contains the optional parameters for the PrivateEndpointConnectionsClient.NewListPager method.
Example ¶
Generated from example definition: 2026-01-01/PrivateEndpointConnections/PrivateEndpointConnectionsList.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPrivateEndpointConnectionsClient().NewListPager("myResourceGroup", "example-RelayNamespace-5849", 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 = armrelay.PrivateEndpointConnectionsClientListResponse{
// PrivateEndpointConnectionListResult: armrelay.PrivateEndpointConnectionListResult{
// Value: []*armrelay.PrivateEndpointConnection{
// {
// Name: to.Ptr("{privateEndpointConnection name}"),
// Type: to.Ptr("Microsoft.Relay/Namespaces/PrivateEndpointConnections"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/alitest/providers/Microsoft.Relay/namespaces/relay-private-endpoint-test/privateEndpointConnections/{privateEndpointConnection name}"),
// Location: to.Ptr("South Central US"),
// Properties: &armrelay.PrivateEndpointConnectionProperties{
// PrivateEndpoint: &armrelay.PrivateEndpoint{
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Network/privateEndpoints/ali-relay-pve-1"),
// },
// PrivateLinkServiceConnectionState: &armrelay.ConnectionState{
// Description: to.Ptr("approve please"),
// Status: to.Ptr(armrelay.PrivateLinkConnectionStatusPending),
// },
// ProvisioningState: to.Ptr(armrelay.EndPointProvisioningStateSucceeded),
// },
// },
// },
// },
// }
}
}
Output:
type PrivateEndpointConnectionsClientBeginDeleteOptions ¶
type PrivateEndpointConnectionsClientBeginDeleteOptions struct {
// Resumes the long-running operation from the provided token.
ResumeToken string
}
PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.
type PrivateEndpointConnectionsClientCreateOrUpdateOptions ¶
type PrivateEndpointConnectionsClientCreateOrUpdateOptions struct {
}
PrivateEndpointConnectionsClientCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.CreateOrUpdate method.
type PrivateEndpointConnectionsClientCreateOrUpdateResponse ¶
type PrivateEndpointConnectionsClientCreateOrUpdateResponse struct {
// Properties of the PrivateEndpointConnection.
PrivateEndpointConnection
}
PrivateEndpointConnectionsClientCreateOrUpdateResponse contains the response from method PrivateEndpointConnectionsClient.CreateOrUpdate.
type PrivateEndpointConnectionsClientDeleteResponse ¶
type PrivateEndpointConnectionsClientDeleteResponse struct {
}
PrivateEndpointConnectionsClientDeleteResponse contains the response from method PrivateEndpointConnectionsClient.BeginDelete.
type PrivateEndpointConnectionsClientGetOptions ¶
type PrivateEndpointConnectionsClientGetOptions struct {
}
PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.
type PrivateEndpointConnectionsClientGetResponse ¶
type PrivateEndpointConnectionsClientGetResponse struct {
// Properties of the PrivateEndpointConnection.
PrivateEndpointConnection
}
PrivateEndpointConnectionsClientGetResponse contains the response from method PrivateEndpointConnectionsClient.Get.
type PrivateEndpointConnectionsClientListOptions ¶
type PrivateEndpointConnectionsClientListOptions struct {
}
PrivateEndpointConnectionsClientListOptions contains the optional parameters for the PrivateEndpointConnectionsClient.NewListPager method.
type PrivateEndpointConnectionsClientListResponse ¶
type PrivateEndpointConnectionsClientListResponse struct {
// The response of a PrivateEndpointConnection list operation.
PrivateEndpointConnectionListResult
}
PrivateEndpointConnectionsClientListResponse contains the response from method PrivateEndpointConnectionsClient.NewListPager.
type PrivateLinkConnectionStatus ¶
type PrivateLinkConnectionStatus string
PrivateLinkConnectionStatus - Status of the connection.
const ( PrivateLinkConnectionStatusApproved PrivateLinkConnectionStatus = "Approved" PrivateLinkConnectionStatusDisconnected PrivateLinkConnectionStatus = "Disconnected" PrivateLinkConnectionStatusPending PrivateLinkConnectionStatus = "Pending" PrivateLinkConnectionStatusRejected PrivateLinkConnectionStatus = "Rejected" )
func PossiblePrivateLinkConnectionStatusValues ¶
func PossiblePrivateLinkConnectionStatusValues() []PrivateLinkConnectionStatus
PossiblePrivateLinkConnectionStatusValues returns the possible values for the PrivateLinkConnectionStatus const type.
type PrivateLinkResource ¶
type PrivateLinkResource struct {
// A resource that supports private link capabilities.
Properties *PrivateLinkResourceProperties
// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ID *string
// READ-ONLY; The name of the resource
Name *string
// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
SystemData *SystemData
// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string
}
PrivateLinkResource - A resource that supports private link capabilities.
func (PrivateLinkResource) MarshalJSON ¶
func (p PrivateLinkResource) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type PrivateLinkResource.
func (*PrivateLinkResource) UnmarshalJSON ¶
func (p *PrivateLinkResource) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResource.
type PrivateLinkResourceProperties ¶
type PrivateLinkResourceProperties struct {
// The private link resource group id.
GroupID *string
// The private link resource required member names.
RequiredMembers []*string
// The private link resource Private link DNS zone name.
RequiredZoneNames []*string
}
PrivateLinkResourceProperties - Properties of PrivateLinkResource
func (PrivateLinkResourceProperties) MarshalJSON ¶
func (p PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceProperties.
func (*PrivateLinkResourceProperties) UnmarshalJSON ¶
func (p *PrivateLinkResourceProperties) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResourceProperties.
type PrivateLinkResourcesClient ¶
type PrivateLinkResourcesClient struct {
// contains filtered or unexported fields
}
PrivateLinkResourcesClient contains the methods for the PrivateLinkResources group. Don't use this type directly, use NewPrivateLinkResourcesClient() instead.
Generated from API version 2026-01-01
func NewPrivateLinkResourcesClient ¶
func NewPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateLinkResourcesClient, error)
NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient with the specified values.
- subscriptionID - The ID of the target subscription. The value must be an UUID.
- credential - used to authorize requests. Usually a credential from azidentity.
- options - Contains optional client configuration. Pass nil to accept the default values.
func (*PrivateLinkResourcesClient) Get ¶
func (client *PrivateLinkResourcesClient) Get(ctx context.Context, resourceGroupName string, namespaceName string, privateLinkResourceName string, options *PrivateLinkResourcesClientGetOptions) (PrivateLinkResourcesClientGetResponse, error)
Get - Gets a private link resource by a specified group name for a container registry. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- privateLinkResourceName - The name of the private link resource.
- options - PrivateLinkResourcesClientGetOptions contains the optional parameters for the PrivateLinkResourcesClient.Get method.
Example ¶
Generated from example definition: 2026-01-01/PrivateEndpointConnections/PrivateLinkResourcesGet.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateLinkResourcesClient().Get(ctx, "resourcegroup", "example-RelayNamespace-5849", "{PrivateLinkResource name}", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.PrivateLinkResourcesClientGetResponse{
// PrivateLinkResource: armrelay.PrivateLinkResource{
// Name: to.Ptr("namespace"),
// Type: to.Ptr("Microsoft.Relay/namespaces/privateLinkResources"),
// ID: to.Ptr("subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/alitest/providers/Microsoft.Relay/namespaces/relay-private-endpoint-test/privateLinkResources/namespace"),
// Properties: &armrelay.PrivateLinkResourceProperties{
// GroupID: to.Ptr("namespace"),
// RequiredMembers: []*string{
// to.Ptr("namespace"),
// },
// RequiredZoneNames: []*string{
// to.Ptr("privatelink.servicebus.windows.net"),
// },
// },
// },
// }
}
Output:
func (*PrivateLinkResourcesClient) List ¶
func (client *PrivateLinkResourcesClient) List(ctx context.Context, resourceGroupName string, namespaceName string, options *PrivateLinkResourcesClientListOptions) (PrivateLinkResourcesClientListResponse, error)
List - Lists the private link resources for a container registry. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- options - PrivateLinkResourcesClientListOptions contains the optional parameters for the PrivateLinkResourcesClient.List method.
Example ¶
Generated from example definition: 2026-01-01/PrivateEndpointConnections/PrivateLinkResourcesList.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateLinkResourcesClient().List(ctx, "resourcegroup", "example-RelayNamespace-5849", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.PrivateLinkResourcesClientListResponse{
// PrivateLinkResourcesListResult: armrelay.PrivateLinkResourcesListResult{
// Value: []*armrelay.PrivateLinkResource{
// {
// Name: to.Ptr("namespace"),
// Type: to.Ptr("Microsoft.Relay/namespaces/privateLinkResources"),
// ID: to.Ptr("subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/alitest/providers/Microsoft.Relay/namespaces/relay-private-endpoint-test/privateLinkResources/namespace"),
// Properties: &armrelay.PrivateLinkResourceProperties{
// GroupID: to.Ptr("namespace"),
// RequiredMembers: []*string{
// to.Ptr("namespace"),
// },
// RequiredZoneNames: []*string{
// to.Ptr("privatelink.servicebus.windows.net"),
// },
// },
// },
// },
// },
// }
}
Output:
type PrivateLinkResourcesClientGetOptions ¶
type PrivateLinkResourcesClientGetOptions struct {
}
PrivateLinkResourcesClientGetOptions contains the optional parameters for the PrivateLinkResourcesClient.Get method.
type PrivateLinkResourcesClientGetResponse ¶
type PrivateLinkResourcesClientGetResponse struct {
// A resource that supports private link capabilities.
PrivateLinkResource
}
PrivateLinkResourcesClientGetResponse contains the response from method PrivateLinkResourcesClient.Get.
type PrivateLinkResourcesClientListOptions ¶
type PrivateLinkResourcesClientListOptions struct {
}
PrivateLinkResourcesClientListOptions contains the optional parameters for the PrivateLinkResourcesClient.List method.
type PrivateLinkResourcesClientListResponse ¶
type PrivateLinkResourcesClientListResponse struct {
// Result of the List private link resources operation.
PrivateLinkResourcesListResult
}
PrivateLinkResourcesClientListResponse contains the response from method PrivateLinkResourcesClient.List.
type PrivateLinkResourcesListResult ¶
type PrivateLinkResourcesListResult struct {
// REQUIRED; A collection of private link resources
Value []*PrivateLinkResource
// A link for the next page of private link resources.
NextLink *string
}
PrivateLinkResourcesListResult - Result of the List private link resources operation.
func (PrivateLinkResourcesListResult) MarshalJSON ¶
func (p PrivateLinkResourcesListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourcesListResult.
func (*PrivateLinkResourcesListResult) UnmarshalJSON ¶
func (p *PrivateLinkResourcesListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResourcesListResult.
type PublicNetworkAccess ¶
type PublicNetworkAccess string
PublicNetworkAccess - This determines if traffic is allowed over public network. By default it is enabled.
const ( PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled" PublicNetworkAccessEnabled PublicNetworkAccess = "Enabled" PublicNetworkAccessSecuredByPerimeter PublicNetworkAccess = "SecuredByPerimeter" )
func PossiblePublicNetworkAccessValues ¶
func PossiblePublicNetworkAccessValues() []PublicNetworkAccess
PossiblePublicNetworkAccessValues returns the possible values for the PublicNetworkAccess const type.
type RegenerateAccessKeyParameters ¶
type RegenerateAccessKeyParameters struct {
// REQUIRED; The access key to regenerate.
KeyType *KeyType
// Optional. If the key value is provided, this is set to key type, or autogenerated key value set for key type.
Key *string
}
RegenerateAccessKeyParameters - Parameters supplied to the regenerate authorization rule operation, specifies which key needs to be reset.
func (RegenerateAccessKeyParameters) MarshalJSON ¶
func (r RegenerateAccessKeyParameters) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type RegenerateAccessKeyParameters.
func (*RegenerateAccessKeyParameters) UnmarshalJSON ¶
func (r *RegenerateAccessKeyParameters) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type RegenerateAccessKeyParameters.
type Relaytype ¶
type Relaytype string
Relaytype - WCF relay type.
func PossibleRelaytypeValues ¶
func PossibleRelaytypeValues() []Relaytype
PossibleRelaytypeValues returns the possible values for the Relaytype const type.
type SKU ¶
type SKU struct {
// REQUIRED; Name of this SKU.
Name *SKUName
// The tier of this SKU.
Tier *SKUTier
}
SKU of the namespace.
func (SKU) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type SKU.
func (*SKU) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type SKU.
type SKUName ¶
type SKUName string
SKUName - Name of this SKU.
const (
SKUNameStandard SKUName = "Standard"
)
func PossibleSKUNameValues ¶
func PossibleSKUNameValues() []SKUName
PossibleSKUNameValues returns the possible values for the SKUName const type.
type SKUTier ¶
type SKUTier string
SKUTier - The tier of this SKU.
const (
SKUTierStandard SKUTier = "Standard"
)
func PossibleSKUTierValues ¶
func PossibleSKUTierValues() []SKUTier
PossibleSKUTierValues returns the possible values for the SKUTier const type.
type SystemData ¶
type SystemData struct {
// The timestamp of resource creation (UTC).
CreatedAt *time.Time
// The identity that created the resource.
CreatedBy *string
// The type of identity that created the resource.
CreatedByType *CreatedByType
// The timestamp of resource last modification (UTC)
LastModifiedAt *time.Time
// The identity that last modified the resource.
LastModifiedBy *string
// The type of identity that last modified the resource.
LastModifiedByType *CreatedByType
}
SystemData - Metadata pertaining to creation and last modification of the resource.
func (SystemData) MarshalJSON ¶
func (s SystemData) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type SystemData.
func (*SystemData) UnmarshalJSON ¶
func (s *SystemData) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.
type TLSVersion ¶
type TLSVersion string
TLSVersion - TLS versions supported by Relay namespaces.
const ( // TLSVersion12 - TLS version 1.2. TLSVersion12 TLSVersion = "1.2" // TLSVersion13 - TLS version 1.3. TLSVersion13 TLSVersion = "1.3" )
func PossibleTLSVersionValues ¶
func PossibleTLSVersionValues() []TLSVersion
PossibleTLSVersionValues returns the possible values for the TLSVersion const type.
type UnavailableReason ¶
type UnavailableReason string
UnavailableReason - Specifies the reason for the unavailability of the service.
const ( )
func PossibleUnavailableReasonValues ¶
func PossibleUnavailableReasonValues() []UnavailableReason
PossibleUnavailableReasonValues returns the possible values for the UnavailableReason const type.
type UpdateParameters ¶
type UpdateParameters struct {
// Description of Relay namespace.
Properties *NamespaceProperties
// SKU of the namespace.
SKU *SKU
// Resource tags.
Tags map[string]*string
// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ID *string
// READ-ONLY; The name of the resource
Name *string
// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
SystemData *SystemData
// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string
}
UpdateParameters - Description of a namespace resource.
func (UpdateParameters) MarshalJSON ¶
func (u UpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type UpdateParameters.
func (*UpdateParameters) UnmarshalJSON ¶
func (u *UpdateParameters) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type UpdateParameters.
type WCFRelaysClient ¶
type WCFRelaysClient struct {
// contains filtered or unexported fields
}
WCFRelaysClient contains the methods for the WCFRelays group. Don't use this type directly, use NewWCFRelaysClient() instead.
Generated from API version 2026-01-01
func NewWCFRelaysClient ¶
func NewWCFRelaysClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WCFRelaysClient, error)
NewWCFRelaysClient creates a new instance of WCFRelaysClient with the specified values.
- subscriptionID - The ID of the target subscription. The value must be an UUID.
- credential - used to authorize requests. Usually a credential from azidentity.
- options - Contains optional client configuration. Pass nil to accept the default values.
func (*WCFRelaysClient) CreateOrUpdate ¶
func (client *WCFRelaysClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, namespaceName string, relayName string, parameters WcfRelay, options *WCFRelaysClientCreateOrUpdateOptions) (WCFRelaysClientCreateOrUpdateResponse, error)
CreateOrUpdate - Creates or updates a WCF relay. This operation is idempotent. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- relayName - The relay name.
- parameters - Parameters supplied to create a WCF relay.
- options - WCFRelaysClientCreateOrUpdateOptions contains the optional parameters for the WCFRelaysClient.CreateOrUpdate method.
Example ¶
Generated from example definition: 2026-01-01/Relay/RelayCreate.json
package main
import (
"context"
"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/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewWCFRelaysClient().CreateOrUpdate(ctx, "resourcegroup", "example-RelayNamespace-9953", "example-Relay-Wcf-1194", armrelay.WcfRelay{
Properties: &armrelay.WcfRelayProperties{
RelayType: to.Ptr(armrelay.RelaytypeNetTCP),
RequiresClientAuthorization: to.Ptr(true),
RequiresTransportSecurity: to.Ptr(true),
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.WCFRelaysClientCreateOrUpdateResponse{
// WcfRelay: armrelay.WcfRelay{
// Name: to.Ptr("example-Relay-Wcf-1194"),
// Type: to.Ptr("Microsoft.Relay/WcfRelays"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-9953/WcfRelays/example-Relay-Wcf-1194"),
// Properties: &armrelay.WcfRelayProperties{
// CreatedAt: to.Ptr(time.Date(2017, time.March, 16, 0, 26, 17, 501466100, time.UTC)),
// IsDynamic: to.Ptr(false),
// RelayType: to.Ptr(armrelay.RelaytypeNetTCP),
// RequiresClientAuthorization: to.Ptr(true),
// RequiresTransportSecurity: to.Ptr(true),
// UpdatedAt: to.Ptr(time.Date(2017, time.March, 16, 0, 26, 17, 501466100, time.UTC)),
// },
// },
// }
}
Output:
func (*WCFRelaysClient) CreateOrUpdateAuthorizationRule ¶
func (client *WCFRelaysClient) CreateOrUpdateAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, relayName string, authorizationRuleName string, parameters AuthorizationRule, options *WCFRelaysClientCreateOrUpdateAuthorizationRuleOptions) (WCFRelaysClientCreateOrUpdateAuthorizationRuleResponse, error)
CreateOrUpdateAuthorizationRule - Creates or updates an authorization rule for a WCF relay. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- relayName - The relay name.
- authorizationRuleName - The authorization rule name.
- parameters - The authorization rule parameters.
- options - WCFRelaysClientCreateOrUpdateAuthorizationRuleOptions contains the optional parameters for the WCFRelaysClient.CreateOrUpdateAuthorizationRule method.
Example ¶
Generated from example definition: 2026-01-01/Relay/RelayAuthorizationRuleCreate.json
package main
import (
"context"
"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/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewWCFRelaysClient().CreateOrUpdateAuthorizationRule(ctx, "resourcegroup", "example-RelayNamespace-01", "example-Relay-wcf-01", "example-RelayAuthRules-01", armrelay.AuthorizationRule{
Properties: &armrelay.AuthorizationRuleProperties{
Rights: []*armrelay.AccessRights{
to.Ptr(armrelay.AccessRightsListen),
to.Ptr(armrelay.AccessRightsSend),
},
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.WCFRelaysClientCreateOrUpdateAuthorizationRuleResponse{
// AuthorizationRule: armrelay.AuthorizationRule{
// Name: to.Ptr("example-RelayAuthRules-01"),
// Type: to.Ptr("Microsoft.Relay/Namespaces/WcfRelay/AuthorizationRules"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/WcfRelays/example-Relay-Wcf-01/AuthorizationRules/example-RelayAuthRules-01"),
// Properties: &armrelay.AuthorizationRuleProperties{
// Rights: []*armrelay.AccessRights{
// to.Ptr(armrelay.AccessRightsListen),
// to.Ptr(armrelay.AccessRightsSend),
// },
// },
// },
// }
}
Output:
func (*WCFRelaysClient) Delete ¶
func (client *WCFRelaysClient) Delete(ctx context.Context, resourceGroupName string, namespaceName string, relayName string, options *WCFRelaysClientDeleteOptions) (WCFRelaysClientDeleteResponse, error)
Delete - Deletes a WCF relay. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- relayName - The relay name.
- options - WCFRelaysClientDeleteOptions contains the optional parameters for the WCFRelaysClient.Delete method.
Example ¶
Generated from example definition: 2026-01-01/Relay/RelayDelete.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewWCFRelaysClient().Delete(ctx, "resourcegroup", "example-RelayNamespace-01", "example-Relay-wcf-01", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.WCFRelaysClientDeleteResponse{
// }
}
Output:
func (*WCFRelaysClient) DeleteAuthorizationRule ¶
func (client *WCFRelaysClient) DeleteAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, relayName string, authorizationRuleName string, options *WCFRelaysClientDeleteAuthorizationRuleOptions) (WCFRelaysClientDeleteAuthorizationRuleResponse, error)
DeleteAuthorizationRule - Deletes a WCF relay authorization rule. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- relayName - The relay name.
- authorizationRuleName - The authorization rule name.
- options - WCFRelaysClientDeleteAuthorizationRuleOptions contains the optional parameters for the WCFRelaysClient.DeleteAuthorizationRule method.
Example ¶
Generated from example definition: 2026-01-01/Relay/RelayAuthorizationRuleDelete.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewWCFRelaysClient().DeleteAuthorizationRule(ctx, "resourcegroup", "example-RelayNamespace-01", "example-Relay-wcf-01", "example-RelayAuthRules-01", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.WCFRelaysClientDeleteAuthorizationRuleResponse{
// }
}
Output:
func (*WCFRelaysClient) Get ¶
func (client *WCFRelaysClient) Get(ctx context.Context, resourceGroupName string, namespaceName string, relayName string, options *WCFRelaysClientGetOptions) (WCFRelaysClientGetResponse, error)
Get - Returns the description for the specified WCF relay. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- relayName - The relay name.
- options - WCFRelaysClientGetOptions contains the optional parameters for the WCFRelaysClient.Get method.
Example ¶
Generated from example definition: 2026-01-01/Relay/RelayGet.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewWCFRelaysClient().Get(ctx, "resourcegroup", "example-RelayNamespace-9953", "example-Relay-Wcf-1194", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.WCFRelaysClientGetResponse{
// WcfRelay: armrelay.WcfRelay{
// Name: to.Ptr("example-Relay-Wcf-1194"),
// Type: to.Ptr("Microsoft.Relay/WcfRelays"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/example-RelayNamespace-9953/WcfRelays/example-Relay-Wcf-1194"),
// Properties: &armrelay.WcfRelayProperties{
// CreatedAt: to.Ptr(time.Date(2017, time.March, 16, 0, 26, 17, 501466100, time.UTC)),
// IsDynamic: to.Ptr(false),
// ListenerCount: to.Ptr[int32](0),
// RelayType: to.Ptr(armrelay.RelaytypeNetTCP),
// RequiresClientAuthorization: to.Ptr(true),
// RequiresTransportSecurity: to.Ptr(true),
// UpdatedAt: to.Ptr(time.Date(2017, time.March, 16, 0, 26, 17, 501466100, time.UTC)),
// },
// },
// }
}
Output:
func (*WCFRelaysClient) GetAuthorizationRule ¶
func (client *WCFRelaysClient) GetAuthorizationRule(ctx context.Context, resourceGroupName string, namespaceName string, relayName string, authorizationRuleName string, options *WCFRelaysClientGetAuthorizationRuleOptions) (WCFRelaysClientGetAuthorizationRuleResponse, error)
GetAuthorizationRule - Get authorizationRule for a WCF relay by name. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- relayName - The relay name.
- authorizationRuleName - The authorization rule name.
- options - WCFRelaysClientGetAuthorizationRuleOptions contains the optional parameters for the WCFRelaysClient.GetAuthorizationRule method.
Example ¶
Generated from example definition: 2026-01-01/Relay/RelayAuthorizationRuleGet.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewWCFRelaysClient().GetAuthorizationRule(ctx, "resourcegroup", "example-RelayNamespace-01", "example-Relay-wcf-01", "example-RelayAuthRules-01", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.WCFRelaysClientGetAuthorizationRuleResponse{
// AuthorizationRule: armrelay.AuthorizationRule{
// Name: to.Ptr("example-RelayAuthRules-01"),
// Type: to.Ptr("Microsoft.Relay/Namespaces/WcfRelay/AuthorizationRules"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/WcfRelays/example-Relay-Wcf-01/AuthorizationRules/example-RelayAuthRules-01"),
// Properties: &armrelay.AuthorizationRuleProperties{
// Rights: []*armrelay.AccessRights{
// to.Ptr(armrelay.AccessRightsListen),
// },
// },
// },
// }
}
Output:
func (*WCFRelaysClient) ListKeys ¶
func (client *WCFRelaysClient) ListKeys(ctx context.Context, resourceGroupName string, namespaceName string, relayName string, authorizationRuleName string, options *WCFRelaysClientListKeysOptions) (WCFRelaysClientListKeysResponse, error)
ListKeys - Primary and secondary connection strings to the WCF relay. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- relayName - The relay name.
- authorizationRuleName - The authorization rule name.
- options - WCFRelaysClientListKeysOptions contains the optional parameters for the WCFRelaysClient.ListKeys method.
Example ¶
Generated from example definition: 2026-01-01/Relay/RelayAuthorizationRuleListKey.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewWCFRelaysClient().ListKeys(ctx, "resourcegroup", "example-RelayNamespace-01", "example-Relay-wcf-01", "example-RelayAuthRules-01", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.WCFRelaysClientListKeysResponse{
// AccessKeys: armrelay.AccessKeys{
// KeyName: to.Ptr("example-RelayAuthRules-01"),
// PrimaryConnectionString: to.Ptr("Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################"),
// PrimaryKey: to.Ptr("############################################"),
// SecondaryConnectionString: to.Ptr("Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################"),
// SecondaryKey: to.Ptr("############################################"),
// },
// }
}
Output:
func (*WCFRelaysClient) NewListAuthorizationRulesPager ¶
func (client *WCFRelaysClient) NewListAuthorizationRulesPager(resourceGroupName string, namespaceName string, relayName string, options *WCFRelaysClientListAuthorizationRulesOptions) *runtime.Pager[WCFRelaysClientListAuthorizationRulesResponse]
NewListAuthorizationRulesPager - Authorization rules for a WCF relay.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- relayName - The relay name.
- options - WCFRelaysClientListAuthorizationRulesOptions contains the optional parameters for the WCFRelaysClient.NewListAuthorizationRulesPager method.
Example ¶
Generated from example definition: 2026-01-01/Relay/RelayAuthorizationRuleListAll.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewWCFRelaysClient().NewListAuthorizationRulesPager("resourcegroup", "example-RelayNamespace-01", "example-Relay-Wcf-01", 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 = armrelay.WCFRelaysClientListAuthorizationRulesResponse{
// AuthorizationRuleListResult: armrelay.AuthorizationRuleListResult{
// Value: []*armrelay.AuthorizationRule{
// {
// Name: to.Ptr("example-RelayAuthRules-01"),
// Type: to.Ptr("Microsoft.Relay/Namespaces/WcfRelay/AuthorizationRules"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/WcfRelays/example-Relay-Wcf-01/AuthorizationRules/example-RelayAuthRules-01"),
// Properties: &armrelay.AuthorizationRuleProperties{
// Rights: []*armrelay.AccessRights{
// to.Ptr(armrelay.AccessRightsListen),
// to.Ptr(armrelay.AccessRightsSend),
// },
// },
// },
// },
// },
// }
}
}
Output:
func (*WCFRelaysClient) NewListByNamespacePager ¶
func (client *WCFRelaysClient) NewListByNamespacePager(resourceGroupName string, namespaceName string, options *WCFRelaysClientListByNamespaceOptions) *runtime.Pager[WCFRelaysClientListByNamespaceResponse]
NewListByNamespacePager - Lists the WCF relays within the namespace.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- options - WCFRelaysClientListByNamespaceOptions contains the optional parameters for the WCFRelaysClient.NewListByNamespacePager method.
Example ¶
Generated from example definition: 2026-01-01/Relay/RelayListAll.json
package main
import (
"context"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewWCFRelaysClient().NewListByNamespacePager("resourcegroup", "example-RelayNamespace-01", 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 = armrelay.WCFRelaysClientListByNamespaceResponse{
// WcfRelaysListResult: armrelay.WcfRelaysListResult{
// Value: []*armrelay.WcfRelay{
// {
// Name: to.Ptr("example-Relay-Wcf-01"),
// Type: to.Ptr("Microsoft.Relay/Namespaces/WcfRelays"),
// ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG1-eg/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/WcfRelays/example-Relay-Wcf-01"),
// Properties: &armrelay.WcfRelayProperties{
// CreatedAt: to.Ptr(time.Date(2017, time.January, 24, 0, 46, 27, 4998300, time.UTC)),
// IsDynamic: to.Ptr(false),
// RelayType: to.Ptr(armrelay.RelaytypeNetTCP),
// RequiresClientAuthorization: to.Ptr(true),
// RequiresTransportSecurity: to.Ptr(true),
// UpdatedAt: to.Ptr(time.Date(2017, time.January, 24, 0, 46, 27, 4998300, time.UTC)),
// UserMetadata: to.Ptr("usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored"),
// },
// },
// },
// },
// }
}
}
Output:
func (*WCFRelaysClient) RegenerateKeys ¶
func (client *WCFRelaysClient) RegenerateKeys(ctx context.Context, resourceGroupName string, namespaceName string, relayName string, authorizationRuleName string, parameters RegenerateAccessKeyParameters, options *WCFRelaysClientRegenerateKeysOptions) (WCFRelaysClientRegenerateKeysResponse, error)
RegenerateKeys - Regenerates the primary or secondary connection strings to the WCF relay. If the operation fails it returns an *azcore.ResponseError type.
- resourceGroupName - The name of the resource group. The name is case insensitive.
- namespaceName - The namespace name
- relayName - The relay name.
- authorizationRuleName - The authorization rule name.
- parameters - Parameters supplied to regenerate authorization rule.
- options - WCFRelaysClientRegenerateKeysOptions contains the optional parameters for the WCFRelaysClient.RegenerateKeys method.
Example ¶
Generated from example definition: 2026-01-01/Relay/RelayAuthorizationRuleRegenerateKey.json
package main
import (
"context"
"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/relay/armrelay/v2"
"log"
)
func main() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armrelay.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewWCFRelaysClient().RegenerateKeys(ctx, "resourcegroup", "example-RelayNamespace-01", "example-Relay-wcf-01", "example-RelayAuthRules-01", armrelay.RegenerateAccessKeyParameters{
KeyType: to.Ptr(armrelay.KeyTypePrimaryKey),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armrelay.WCFRelaysClientRegenerateKeysResponse{
// AccessKeys: armrelay.AccessKeys{
// KeyName: to.Ptr("example-RelayAuthRules-01"),
// PrimaryConnectionString: to.Ptr("Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################"),
// PrimaryKey: to.Ptr("############################################"),
// SecondaryConnectionString: to.Ptr("Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################"),
// SecondaryKey: to.Ptr("############################################"),
// },
// }
}
Output:
type WCFRelaysClientCreateOrUpdateAuthorizationRuleOptions ¶
type WCFRelaysClientCreateOrUpdateAuthorizationRuleOptions struct {
}
WCFRelaysClientCreateOrUpdateAuthorizationRuleOptions contains the optional parameters for the WCFRelaysClient.CreateOrUpdateAuthorizationRule method.
type WCFRelaysClientCreateOrUpdateAuthorizationRuleResponse ¶
type WCFRelaysClientCreateOrUpdateAuthorizationRuleResponse struct {
// Single item in a List or Get AuthorizationRule operation
AuthorizationRule
}
WCFRelaysClientCreateOrUpdateAuthorizationRuleResponse contains the response from method WCFRelaysClient.CreateOrUpdateAuthorizationRule.
type WCFRelaysClientCreateOrUpdateOptions ¶
type WCFRelaysClientCreateOrUpdateOptions struct {
}
WCFRelaysClientCreateOrUpdateOptions contains the optional parameters for the WCFRelaysClient.CreateOrUpdate method.
type WCFRelaysClientCreateOrUpdateResponse ¶
type WCFRelaysClientCreateOrUpdateResponse struct {
// Description of the WCF relay resource.
WcfRelay
}
WCFRelaysClientCreateOrUpdateResponse contains the response from method WCFRelaysClient.CreateOrUpdate.
type WCFRelaysClientDeleteAuthorizationRuleOptions ¶
type WCFRelaysClientDeleteAuthorizationRuleOptions struct {
}
WCFRelaysClientDeleteAuthorizationRuleOptions contains the optional parameters for the WCFRelaysClient.DeleteAuthorizationRule method.
type WCFRelaysClientDeleteAuthorizationRuleResponse ¶
type WCFRelaysClientDeleteAuthorizationRuleResponse struct {
}
WCFRelaysClientDeleteAuthorizationRuleResponse contains the response from method WCFRelaysClient.DeleteAuthorizationRule.
type WCFRelaysClientDeleteOptions ¶
type WCFRelaysClientDeleteOptions struct {
}
WCFRelaysClientDeleteOptions contains the optional parameters for the WCFRelaysClient.Delete method.
type WCFRelaysClientDeleteResponse ¶
type WCFRelaysClientDeleteResponse struct {
}
WCFRelaysClientDeleteResponse contains the response from method WCFRelaysClient.Delete.
type WCFRelaysClientGetAuthorizationRuleOptions ¶
type WCFRelaysClientGetAuthorizationRuleOptions struct {
}
WCFRelaysClientGetAuthorizationRuleOptions contains the optional parameters for the WCFRelaysClient.GetAuthorizationRule method.
type WCFRelaysClientGetAuthorizationRuleResponse ¶
type WCFRelaysClientGetAuthorizationRuleResponse struct {
// Single item in a List or Get AuthorizationRule operation
AuthorizationRule
}
WCFRelaysClientGetAuthorizationRuleResponse contains the response from method WCFRelaysClient.GetAuthorizationRule.
type WCFRelaysClientGetOptions ¶
type WCFRelaysClientGetOptions struct {
}
WCFRelaysClientGetOptions contains the optional parameters for the WCFRelaysClient.Get method.
type WCFRelaysClientGetResponse ¶
type WCFRelaysClientGetResponse struct {
// Description of the WCF relay resource.
WcfRelay
}
WCFRelaysClientGetResponse contains the response from method WCFRelaysClient.Get.
type WCFRelaysClientListAuthorizationRulesOptions ¶
type WCFRelaysClientListAuthorizationRulesOptions struct {
}
WCFRelaysClientListAuthorizationRulesOptions contains the optional parameters for the WCFRelaysClient.NewListAuthorizationRulesPager method.
type WCFRelaysClientListAuthorizationRulesResponse ¶
type WCFRelaysClientListAuthorizationRulesResponse struct {
// The response of a AuthorizationRule list operation.
AuthorizationRuleListResult
}
WCFRelaysClientListAuthorizationRulesResponse contains the response from method WCFRelaysClient.NewListAuthorizationRulesPager.
type WCFRelaysClientListByNamespaceOptions ¶
type WCFRelaysClientListByNamespaceOptions struct {
}
WCFRelaysClientListByNamespaceOptions contains the optional parameters for the WCFRelaysClient.NewListByNamespacePager method.
type WCFRelaysClientListByNamespaceResponse ¶
type WCFRelaysClientListByNamespaceResponse struct {
// The response of the list WCF relay operation.
WcfRelaysListResult
}
WCFRelaysClientListByNamespaceResponse contains the response from method WCFRelaysClient.NewListByNamespacePager.
type WCFRelaysClientListKeysOptions ¶
type WCFRelaysClientListKeysOptions struct {
}
WCFRelaysClientListKeysOptions contains the optional parameters for the WCFRelaysClient.ListKeys method.
type WCFRelaysClientListKeysResponse ¶
type WCFRelaysClientListKeysResponse struct {
// Namespace/Relay Connection String
AccessKeys
}
WCFRelaysClientListKeysResponse contains the response from method WCFRelaysClient.ListKeys.
type WCFRelaysClientRegenerateKeysOptions ¶
type WCFRelaysClientRegenerateKeysOptions struct {
}
WCFRelaysClientRegenerateKeysOptions contains the optional parameters for the WCFRelaysClient.RegenerateKeys method.
type WCFRelaysClientRegenerateKeysResponse ¶
type WCFRelaysClientRegenerateKeysResponse struct {
// Namespace/Relay Connection String
AccessKeys
}
WCFRelaysClientRegenerateKeysResponse contains the response from method WCFRelaysClient.RegenerateKeys.
type WcfRelay ¶
type WcfRelay struct {
// Properties of the WCF relay.
Properties *WcfRelayProperties
// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ID *string
// READ-ONLY; The geo-location where the resource lives
Location *string
// READ-ONLY; The name of the resource
Name *string
// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
SystemData *SystemData
// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string
}
WcfRelay - Description of the WCF relay resource.
func (WcfRelay) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type WcfRelay.
func (*WcfRelay) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type WcfRelay.
type WcfRelayProperties ¶
type WcfRelayProperties struct {
// WCF relay type.
RelayType *Relaytype
// Returns true if client authorization is needed for this relay; otherwise, false.
RequiresClientAuthorization *bool
// Returns true if transport security is needed for this relay; otherwise, false.
RequiresTransportSecurity *bool
// The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be
// used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings
// can be stored.
UserMetadata *string
// READ-ONLY; The time the WCF relay was created.
CreatedAt *time.Time
// READ-ONLY; Returns true if the relay is dynamic; otherwise, false.
IsDynamic *bool
// READ-ONLY; The number of listeners for this relay. Note that min :1 and max:25 are supported.
ListenerCount *int32
// READ-ONLY; The time the namespace was updated.
UpdatedAt *time.Time
}
WcfRelayProperties - Properties of the WCF relay.
func (WcfRelayProperties) MarshalJSON ¶
func (w WcfRelayProperties) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type WcfRelayProperties.
func (*WcfRelayProperties) UnmarshalJSON ¶
func (w *WcfRelayProperties) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type WcfRelayProperties.
type WcfRelaysListResult ¶
type WcfRelaysListResult struct {
// REQUIRED; The WcfRelay items on this page
Value []*WcfRelay
// The link to the next page of items
NextLink *string
}
WcfRelaysListResult - The response of the list WCF relay operation.
func (WcfRelaysListResult) MarshalJSON ¶
func (w WcfRelaysListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type WcfRelaysListResult.
func (*WcfRelaysListResult) UnmarshalJSON ¶
func (w *WcfRelaysListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type WcfRelaysListResult.