apikey

README

github.com/hashicorp/go-azure-sdk/resource-manager/elastic/2024-03-01/apikey Documentation

The apikey SDK allows for interaction with the Azure Resource Manager Service elastic (API Version 2024-03-01).

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

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/elastic/2024-03-01/apikey"

Client Initialization

client := apikey.NewApiKeyClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApiKeyClient.OrganizationsGetApiKey

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

payload := apikey.UserEmailId{
	// ...
}


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

Documentation

Index

• type ApiKeyClient
  • func NewApiKeyClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiKeyClient, error)
  • func (c ApiKeyClient) OrganizationsGetApiKey(ctx context.Context, id commonids.SubscriptionId, input UserEmailId) (result OrganizationsGetApiKeyOperationResponse, err error)
• type OrganizationsGetApiKeyOperationResponse
• type UserApiKeyResponse
• type UserApiKeyResponseProperties
• type UserEmailId

Types

type ApiKeyClient

type ApiKeyClient struct {
	Client *resourcemanager.Client
}

func NewApiKeyClientWithBaseURI

func NewApiKeyClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiKeyClient, error)

func (ApiKeyClient) OrganizationsGetApiKey

func (c ApiKeyClient) OrganizationsGetApiKey(ctx context.Context, id commonids.SubscriptionId, input UserEmailId) (result OrganizationsGetApiKeyOperationResponse, err error)

OrganizationsGetApiKey ...

type OrganizationsGetApiKeyOperationResponse

type OrganizationsGetApiKeyOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *UserApiKeyResponse
}

type UserApiKeyResponse

type UserApiKeyResponse struct {
	Properties *UserApiKeyResponseProperties `json:"properties,omitempty"`
}

type UserApiKeyResponseProperties

type UserApiKeyResponseProperties struct {
	ApiKey *string `json:"apiKey,omitempty"`
}

type UserEmailId

type UserEmailId struct {
	EmailId *string `json:"emailId,omitempty"`
}