Documentation ¶
Overview ¶
Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/healthcareapis/armhealthcareapis(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/healthcareapis/armhealthcareapis). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.
Package healthcareapis implements the Azure ARM Healthcareapis service API version 2019-09-16.
Azure Healthcare APIs Client
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type BaseClient
- type CheckNameAvailabilityParameters
- type ErrorDetails
- type ErrorDetailsInternal
- type Kind
- type ManagedServiceIdentityType
- type Operation
- type OperationDisplay
- type OperationListResult
- type OperationListResultIterator
- func (iter *OperationListResultIterator) Next() error
- func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter OperationListResultIterator) NotDone() bool
- func (iter OperationListResultIterator) Response() OperationListResult
- func (iter OperationListResultIterator) Value() Operation
- type OperationListResultPage
- func (page *OperationListResultPage) Next() error
- func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page OperationListResultPage) NotDone() bool
- func (page OperationListResultPage) Response() OperationListResult
- func (page OperationListResultPage) Values() []Operation
- type OperationResultStatus
- type OperationResultsClient
- func (client OperationResultsClient) Get(ctx context.Context, locationName string, operationResultID string) (result SetObject, err error)
- func (client OperationResultsClient) GetPreparer(ctx context.Context, locationName string, operationResultID string) (*http.Request, error)
- func (client OperationResultsClient) GetResponder(resp *http.Response) (result SetObject, err error)
- func (client OperationResultsClient) GetSender(req *http.Request) (*http.Response, error)
- type OperationResultsDescription
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
- func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
- type ProvisioningState
- type Resource
- type ResourceIdentity
- type ServiceAccessPolicyEntry
- type ServiceAuthenticationConfigurationInfo
- type ServiceCorsConfigurationInfo
- type ServiceCosmosDbConfigurationInfo
- type ServiceExportConfigurationInfo
- type ServiceNameUnavailabilityReason
- type ServicesClient
- func (client ServicesClient) CheckNameAvailability(ctx context.Context, ...) (result ServicesNameAvailabilityInfo, err error)
- func (client ServicesClient) CheckNameAvailabilityPreparer(ctx context.Context, ...) (*http.Request, error)
- func (client ServicesClient) CheckNameAvailabilityResponder(resp *http.Response) (result ServicesNameAvailabilityInfo, err error)
- func (client ServicesClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)
- func (client ServicesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, ...) (result ServicesCreateOrUpdateFuture, err error)
- func (client ServicesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, ...) (*http.Request, error)
- func (client ServicesClient) CreateOrUpdateResponder(resp *http.Response) (result ServicesDescription, err error)
- func (client ServicesClient) CreateOrUpdateSender(req *http.Request) (future ServicesCreateOrUpdateFuture, err error)
- func (client ServicesClient) Delete(ctx context.Context, resourceGroupName string, resourceName string) (result ServicesDeleteFuture, err error)
- func (client ServicesClient) DeletePreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
- func (client ServicesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client ServicesClient) DeleteSender(req *http.Request) (future ServicesDeleteFuture, err error)
- func (client ServicesClient) Get(ctx context.Context, resourceGroupName string, resourceName string) (result ServicesDescription, err error)
- func (client ServicesClient) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
- func (client ServicesClient) GetResponder(resp *http.Response) (result ServicesDescription, err error)
- func (client ServicesClient) GetSender(req *http.Request) (*http.Response, error)
- func (client ServicesClient) List(ctx context.Context) (result ServicesDescriptionListResultPage, err error)
- func (client ServicesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ServicesDescriptionListResultPage, err error)
- func (client ServicesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ServicesDescriptionListResultIterator, err error)
- func (client ServicesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
- func (client ServicesClient) ListByResourceGroupResponder(resp *http.Response) (result ServicesDescriptionListResult, err error)
- func (client ServicesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client ServicesClient) ListComplete(ctx context.Context) (result ServicesDescriptionListResultIterator, err error)
- func (client ServicesClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client ServicesClient) ListResponder(resp *http.Response) (result ServicesDescriptionListResult, err error)
- func (client ServicesClient) ListSender(req *http.Request) (*http.Response, error)
- func (client ServicesClient) Update(ctx context.Context, resourceGroupName string, resourceName string, ...) (result ServicesUpdateFuture, err error)
- func (client ServicesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, ...) (*http.Request, error)
- func (client ServicesClient) UpdateResponder(resp *http.Response) (result ServicesDescription, err error)
- func (client ServicesClient) UpdateSender(req *http.Request) (future ServicesUpdateFuture, err error)
- type ServicesCreateOrUpdateFuture
- type ServicesDeleteFuture
- type ServicesDescription
- type ServicesDescriptionListResult
- type ServicesDescriptionListResultIterator
- func (iter *ServicesDescriptionListResultIterator) Next() error
- func (iter *ServicesDescriptionListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter ServicesDescriptionListResultIterator) NotDone() bool
- func (iter ServicesDescriptionListResultIterator) Response() ServicesDescriptionListResult
- func (iter ServicesDescriptionListResultIterator) Value() ServicesDescription
- type ServicesDescriptionListResultPage
- func (page *ServicesDescriptionListResultPage) Next() error
- func (page *ServicesDescriptionListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page ServicesDescriptionListResultPage) NotDone() bool
- func (page ServicesDescriptionListResultPage) Response() ServicesDescriptionListResult
- func (page ServicesDescriptionListResultPage) Values() []ServicesDescription
- type ServicesNameAvailabilityInfo
- type ServicesPatchDescription
- type ServicesProperties
- type ServicesUpdateFuture
- type SetObject
Constants ¶
const (
// DefaultBaseURI is the default URI used for the service Healthcareapis
DefaultBaseURI = "https://management.azure.com"
)
Variables ¶
This section is empty.
Functions ¶
func UserAgent ¶
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version ¶
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
Types ¶
type BaseClient ¶
BaseClient is the base client for Healthcareapis.
func New ¶
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
type CheckNameAvailabilityParameters ¶
type CheckNameAvailabilityParameters struct { // Name - The name of the service instance to check. Name *string `json:"name,omitempty"` // Type - The fully qualified resource type which includes provider namespace. Type *string `json:"type,omitempty"` }
CheckNameAvailabilityParameters input values.
type ErrorDetails ¶
type ErrorDetails struct { // Error - Object containing error details. Error *ErrorDetailsInternal `json:"error,omitempty"` }
ErrorDetails error details.
type ErrorDetailsInternal ¶
type ErrorDetailsInternal struct { // Code - READ-ONLY; The error code. Code *string `json:"code,omitempty"` // Message - READ-ONLY; The error message. Message *string `json:"message,omitempty"` // Target - READ-ONLY; The target of the particular error. Target *string `json:"target,omitempty"` }
ErrorDetailsInternal error details.
func (ErrorDetailsInternal) MarshalJSON ¶
func (edi ErrorDetailsInternal) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ErrorDetailsInternal.
type Kind ¶
type Kind string
Kind enumerates the values for kind.
func PossibleKindValues ¶
func PossibleKindValues() []Kind
PossibleKindValues returns an array of possible values for the Kind const type.
type ManagedServiceIdentityType ¶
type ManagedServiceIdentityType string
ManagedServiceIdentityType enumerates the values for managed service identity type.
const ( // None ... None ManagedServiceIdentityType = "None" // SystemAssigned ... SystemAssigned ManagedServiceIdentityType = "SystemAssigned" )
func PossibleManagedServiceIdentityTypeValues ¶
func PossibleManagedServiceIdentityTypeValues() []ManagedServiceIdentityType
PossibleManagedServiceIdentityTypeValues returns an array of possible values for the ManagedServiceIdentityType const type.
type Operation ¶
type Operation struct { // Name - READ-ONLY; Operation name: {provider}/{resource}/{read | write | action | delete} Name *string `json:"name,omitempty"` // Origin - READ-ONLY; Default value is 'user,system'. Origin *string `json:"origin,omitempty"` // Display - The information displayed about the operation. Display *OperationDisplay `json:"display,omitempty"` }
Operation service REST API operation.
func (Operation) MarshalJSON ¶
MarshalJSON is the custom marshaler for Operation.
type OperationDisplay ¶
type OperationDisplay struct { // Provider - READ-ONLY; Service provider: Microsoft.HealthcareApis Provider *string `json:"provider,omitempty"` // Resource - READ-ONLY; Resource Type: Services Resource *string `json:"resource,omitempty"` // Operation - READ-ONLY; Name of the operation Operation *string `json:"operation,omitempty"` // Description - READ-ONLY; Friendly description for the operation, Description *string `json:"description,omitempty"` }
OperationDisplay the object that represents the operation.
func (OperationDisplay) MarshalJSON ¶
func (od OperationDisplay) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationDisplay.
type OperationListResult ¶
type OperationListResult struct { autorest.Response `json:"-"` // NextLink - The link used to get the next page of service description objects. NextLink *string `json:"nextLink,omitempty"` // Value - READ-ONLY; A list of service operations supported by the Microsoft.HealthcareApis resource provider. Value *[]Operation `json:"value,omitempty"` }
OperationListResult a list of service operations. It contains a list of operations and a URL link to get the next set of results.
func (OperationListResult) IsEmpty ¶
func (olr OperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (OperationListResult) MarshalJSON ¶
func (olr OperationListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationListResult.
type OperationListResultIterator ¶
type OperationListResultIterator struct {
// contains filtered or unexported fields
}
OperationListResultIterator provides access to a complete listing of Operation values.
func NewOperationListResultIterator ¶
func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator
Creates a new instance of the OperationListResultIterator type.
func (*OperationListResultIterator) Next ¶
func (iter *OperationListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*OperationListResultIterator) NextWithContext ¶
func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (OperationListResultIterator) NotDone ¶
func (iter OperationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (OperationListResultIterator) Response ¶
func (iter OperationListResultIterator) Response() OperationListResult
Response returns the raw server response from the last page request.
func (OperationListResultIterator) Value ¶
func (iter OperationListResultIterator) Value() Operation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type OperationListResultPage ¶
type OperationListResultPage struct {
// contains filtered or unexported fields
}
OperationListResultPage contains a page of Operation values.
func NewOperationListResultPage ¶
func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage
Creates a new instance of the OperationListResultPage type.
func (*OperationListResultPage) Next ¶
func (page *OperationListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*OperationListResultPage) NextWithContext ¶
func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (OperationListResultPage) NotDone ¶
func (page OperationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (OperationListResultPage) Response ¶
func (page OperationListResultPage) Response() OperationListResult
Response returns the raw server response from the last page request.
func (OperationListResultPage) Values ¶
func (page OperationListResultPage) Values() []Operation
Values returns the slice of values for the current page or nil if there are no values.
type OperationResultStatus ¶
type OperationResultStatus string
OperationResultStatus enumerates the values for operation result status.
const ( // Canceled ... Canceled OperationResultStatus = "Canceled" // Failed ... Failed OperationResultStatus = "Failed" // Requested ... Requested OperationResultStatus = "Requested" // Running ... Running OperationResultStatus = "Running" // Succeeded ... Succeeded OperationResultStatus = "Succeeded" )
func PossibleOperationResultStatusValues ¶
func PossibleOperationResultStatusValues() []OperationResultStatus
PossibleOperationResultStatusValues returns an array of possible values for the OperationResultStatus const type.
type OperationResultsClient ¶
type OperationResultsClient struct {
BaseClient
}
OperationResultsClient is the azure Healthcare APIs Client
func NewOperationResultsClient ¶
func NewOperationResultsClient(subscriptionID string) OperationResultsClient
NewOperationResultsClient creates an instance of the OperationResultsClient client.
func NewOperationResultsClientWithBaseURI ¶
func NewOperationResultsClientWithBaseURI(baseURI string, subscriptionID string) OperationResultsClient
NewOperationResultsClientWithBaseURI creates an instance of the OperationResultsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (OperationResultsClient) Get ¶
func (client OperationResultsClient) Get(ctx context.Context, locationName string, operationResultID string) (result SetObject, err error)
Get get the operation result for a long running operation. Parameters: locationName - the location of the operation. operationResultID - the ID of the operation result to get.
func (OperationResultsClient) GetPreparer ¶
func (client OperationResultsClient) GetPreparer(ctx context.Context, locationName string, operationResultID string) (*http.Request, error)
GetPreparer prepares the Get request.
func (OperationResultsClient) GetResponder ¶
func (client OperationResultsClient) GetResponder(resp *http.Response) (result SetObject, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
type OperationResultsDescription ¶
type OperationResultsDescription struct { // ID - READ-ONLY; The ID of the operation returned. ID *string `json:"id,omitempty"` // Name - READ-ONLY; The name of the operation result. Name *string `json:"name,omitempty"` // Status - READ-ONLY; The status of the operation being performed. Possible values include: 'Canceled', 'Succeeded', 'Failed', 'Requested', 'Running' Status OperationResultStatus `json:"status,omitempty"` // StartTime - READ-ONLY; The time that the operation was started. StartTime *string `json:"startTime,omitempty"` // Properties - Additional properties of the operation result. Properties interface{} `json:"properties,omitempty"` }
OperationResultsDescription the properties indicating the operation result of an operation on a service.
func (OperationResultsDescription) MarshalJSON ¶
func (ord OperationResultsDescription) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationResultsDescription.
type OperationsClient ¶
type OperationsClient struct {
BaseClient
}
OperationsClient is the azure Healthcare APIs Client
func NewOperationsClient ¶
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI ¶
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (OperationsClient) List ¶
func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
List lists all of the available Healthcare service REST API operations.
func (OperationsClient) ListComplete ¶
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (OperationsClient) ListPreparer ¶
ListPreparer prepares the List request.
func (OperationsClient) ListResponder ¶
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (OperationsClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type ProvisioningState ¶
type ProvisioningState string
ProvisioningState enumerates the values for provisioning state.
const ( // ProvisioningStateAccepted ... ProvisioningStateAccepted ProvisioningState = "Accepted" // ProvisioningStateCanceled ... ProvisioningStateCanceled ProvisioningState = "Canceled" // ProvisioningStateCreating ... ProvisioningStateCreating ProvisioningState = "Creating" // ProvisioningStateDeleting ... ProvisioningStateDeleting ProvisioningState = "Deleting" // ProvisioningStateDeprovisioned ... ProvisioningStateDeprovisioned ProvisioningState = "Deprovisioned" // ProvisioningStateFailed ... ProvisioningStateFailed ProvisioningState = "Failed" // ProvisioningStateSucceeded ... ProvisioningStateSucceeded ProvisioningState = "Succeeded" // ProvisioningStateUpdating ... ProvisioningStateUpdating ProvisioningState = "Updating" // ProvisioningStateVerifying ... ProvisioningStateVerifying ProvisioningState = "Verifying" )
func PossibleProvisioningStateValues ¶
func PossibleProvisioningStateValues() []ProvisioningState
PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.
type Resource ¶
type Resource struct { // ID - READ-ONLY; The resource identifier. ID *string `json:"id,omitempty"` // Name - READ-ONLY; The resource name. Name *string `json:"name,omitempty"` // Type - READ-ONLY; The resource type. Type *string `json:"type,omitempty"` // Kind - The kind of the service. Possible values include: 'Fhir', 'FhirStu3', 'FhirR4' Kind Kind `json:"kind,omitempty"` // Location - The resource location. Location *string `json:"location,omitempty"` // Tags - The resource tags. Tags map[string]*string `json:"tags"` // Etag - An etag associated with the resource, used for optimistic concurrency when editing it. Etag *string `json:"etag,omitempty"` // Identity - Setting indicating whether the service has a managed identity associated with it. Identity *ResourceIdentity `json:"identity,omitempty"` }
Resource the common properties of a service.
func (Resource) MarshalJSON ¶
MarshalJSON is the custom marshaler for Resource.
type ResourceIdentity ¶
type ResourceIdentity struct { // PrincipalID - READ-ONLY; The principal ID of the resource identity. PrincipalID *string `json:"principalId,omitempty"` // TenantID - READ-ONLY; The tenant ID of the resource. TenantID *string `json:"tenantId,omitempty"` // Type - Type of identity being specified, currently SystemAssigned and None are allowed. Possible values include: 'SystemAssigned', 'None' Type ManagedServiceIdentityType `json:"type,omitempty"` }
ResourceIdentity setting indicating whether the service has a managed identity associated with it.
func (ResourceIdentity) MarshalJSON ¶
func (r ResourceIdentity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceIdentity.
type ServiceAccessPolicyEntry ¶
type ServiceAccessPolicyEntry struct { // ObjectID - An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. ObjectID *string `json:"objectId,omitempty"` }
ServiceAccessPolicyEntry an access policy entry.
type ServiceAuthenticationConfigurationInfo ¶
type ServiceAuthenticationConfigurationInfo struct { // Authority - The authority url for the service Authority *string `json:"authority,omitempty"` // Audience - The audience url for the service Audience *string `json:"audience,omitempty"` // SmartProxyEnabled - If the SMART on FHIR proxy is enabled SmartProxyEnabled *bool `json:"smartProxyEnabled,omitempty"` }
ServiceAuthenticationConfigurationInfo authentication configuration information
type ServiceCorsConfigurationInfo ¶
type ServiceCorsConfigurationInfo struct { // Origins - The origins to be allowed via CORS. Origins *[]string `json:"origins,omitempty"` // Headers - The headers to be allowed via CORS. Headers *[]string `json:"headers,omitempty"` // Methods - The methods to be allowed via CORS. Methods *[]string `json:"methods,omitempty"` // MaxAge - The max age to be allowed via CORS. MaxAge *int32 `json:"maxAge,omitempty"` // AllowCredentials - If credentials are allowed via CORS. AllowCredentials *bool `json:"allowCredentials,omitempty"` }
ServiceCorsConfigurationInfo the settings for the CORS configuration of the service instance.
type ServiceCosmosDbConfigurationInfo ¶
type ServiceCosmosDbConfigurationInfo struct { // OfferThroughput - The provisioned throughput for the backing database. OfferThroughput *int32 `json:"offerThroughput,omitempty"` }
ServiceCosmosDbConfigurationInfo the settings for the Cosmos DB database backing the service.
type ServiceExportConfigurationInfo ¶
type ServiceExportConfigurationInfo struct { // StorageAccountName - The name of the default export storage account. StorageAccountName *string `json:"storageAccountName,omitempty"` }
ServiceExportConfigurationInfo export operation configuration information
type ServiceNameUnavailabilityReason ¶
type ServiceNameUnavailabilityReason string
ServiceNameUnavailabilityReason enumerates the values for service name unavailability reason.
const ( // AlreadyExists ... AlreadyExists ServiceNameUnavailabilityReason = "AlreadyExists" // Invalid ... Invalid ServiceNameUnavailabilityReason = "Invalid" )
func PossibleServiceNameUnavailabilityReasonValues ¶
func PossibleServiceNameUnavailabilityReasonValues() []ServiceNameUnavailabilityReason
PossibleServiceNameUnavailabilityReasonValues returns an array of possible values for the ServiceNameUnavailabilityReason const type.
type ServicesClient ¶
type ServicesClient struct {
BaseClient
}
ServicesClient is the azure Healthcare APIs Client
func NewServicesClient ¶
func NewServicesClient(subscriptionID string) ServicesClient
NewServicesClient creates an instance of the ServicesClient client.
func NewServicesClientWithBaseURI ¶
func NewServicesClientWithBaseURI(baseURI string, subscriptionID string) ServicesClient
NewServicesClientWithBaseURI creates an instance of the ServicesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (ServicesClient) CheckNameAvailability ¶
func (client ServicesClient) CheckNameAvailability(ctx context.Context, checkNameAvailabilityInputs CheckNameAvailabilityParameters) (result ServicesNameAvailabilityInfo, err error)
CheckNameAvailability check if a service instance name is available. Parameters: checkNameAvailabilityInputs - set the name parameter in the CheckNameAvailabilityParameters structure to the name of the service instance to check.
func (ServicesClient) CheckNameAvailabilityPreparer ¶
func (client ServicesClient) CheckNameAvailabilityPreparer(ctx context.Context, checkNameAvailabilityInputs CheckNameAvailabilityParameters) (*http.Request, error)
CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.
func (ServicesClient) CheckNameAvailabilityResponder ¶
func (client ServicesClient) CheckNameAvailabilityResponder(resp *http.Response) (result ServicesNameAvailabilityInfo, err error)
CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.
func (ServicesClient) CheckNameAvailabilitySender ¶
CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.
func (ServicesClient) CreateOrUpdate ¶
func (client ServicesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, serviceDescription ServicesDescription) (result ServicesCreateOrUpdateFuture, err error)
CreateOrUpdate create or update the metadata of a service instance. Parameters: resourceGroupName - the name of the resource group that contains the service instance. resourceName - the name of the service instance. serviceDescription - the service instance metadata.
func (ServicesClient) CreateOrUpdatePreparer ¶
func (client ServicesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, serviceDescription ServicesDescription) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (ServicesClient) CreateOrUpdateResponder ¶
func (client ServicesClient) CreateOrUpdateResponder(resp *http.Response) (result ServicesDescription, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (ServicesClient) CreateOrUpdateSender ¶
func (client ServicesClient) CreateOrUpdateSender(req *http.Request) (future ServicesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (ServicesClient) Delete ¶
func (client ServicesClient) Delete(ctx context.Context, resourceGroupName string, resourceName string) (result ServicesDeleteFuture, err error)
Delete delete a service instance. Parameters: resourceGroupName - the name of the resource group that contains the service instance. resourceName - the name of the service instance.
func (ServicesClient) DeletePreparer ¶
func (client ServicesClient) DeletePreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (ServicesClient) DeleteResponder ¶
func (client ServicesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (ServicesClient) DeleteSender ¶
func (client ServicesClient) DeleteSender(req *http.Request) (future ServicesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (ServicesClient) Get ¶
func (client ServicesClient) Get(ctx context.Context, resourceGroupName string, resourceName string) (result ServicesDescription, err error)
Get get the metadata of a service instance. Parameters: resourceGroupName - the name of the resource group that contains the service instance. resourceName - the name of the service instance.
func (ServicesClient) GetPreparer ¶
func (client ServicesClient) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (ServicesClient) GetResponder ¶
func (client ServicesClient) GetResponder(resp *http.Response) (result ServicesDescription, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (ServicesClient) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (ServicesClient) List ¶
func (client ServicesClient) List(ctx context.Context) (result ServicesDescriptionListResultPage, err error)
List get all the service instances in a subscription.
func (ServicesClient) ListByResourceGroup ¶
func (client ServicesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ServicesDescriptionListResultPage, err error)
ListByResourceGroup get all the service instances in a resource group. Parameters: resourceGroupName - the name of the resource group that contains the service instance.
func (ServicesClient) ListByResourceGroupComplete ¶
func (client ServicesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ServicesDescriptionListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (ServicesClient) ListByResourceGroupPreparer ¶
func (client ServicesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (ServicesClient) ListByResourceGroupResponder ¶
func (client ServicesClient) ListByResourceGroupResponder(resp *http.Response) (result ServicesDescriptionListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (ServicesClient) ListByResourceGroupSender ¶
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (ServicesClient) ListComplete ¶
func (client ServicesClient) ListComplete(ctx context.Context) (result ServicesDescriptionListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (ServicesClient) ListPreparer ¶
ListPreparer prepares the List request.
func (ServicesClient) ListResponder ¶
func (client ServicesClient) ListResponder(resp *http.Response) (result ServicesDescriptionListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (ServicesClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (ServicesClient) Update ¶
func (client ServicesClient) Update(ctx context.Context, resourceGroupName string, resourceName string, servicePatchDescription ServicesPatchDescription) (result ServicesUpdateFuture, err error)
Update update the metadata of a service instance. Parameters: resourceGroupName - the name of the resource group that contains the service instance. resourceName - the name of the service instance. servicePatchDescription - the service instance metadata and security metadata.
func (ServicesClient) UpdatePreparer ¶
func (client ServicesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, servicePatchDescription ServicesPatchDescription) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (ServicesClient) UpdateResponder ¶
func (client ServicesClient) UpdateResponder(resp *http.Response) (result ServicesDescription, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (ServicesClient) UpdateSender ¶
func (client ServicesClient) UpdateSender(req *http.Request) (future ServicesUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type ServicesCreateOrUpdateFuture ¶
type ServicesCreateOrUpdateFuture struct { azure.FutureAPI // Result returns the result of the asynchronous operation. // If the operation has not completed it will return an error. Result func(ServicesClient) (ServicesDescription, error) }
ServicesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*ServicesCreateOrUpdateFuture) UnmarshalJSON ¶
func (future *ServicesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
type ServicesDeleteFuture ¶
type ServicesDeleteFuture struct { azure.FutureAPI // Result returns the result of the asynchronous operation. // If the operation has not completed it will return an error. Result func(ServicesClient) (autorest.Response, error) }
ServicesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*ServicesDeleteFuture) UnmarshalJSON ¶
func (future *ServicesDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
type ServicesDescription ¶
type ServicesDescription struct { autorest.Response `json:"-"` // Properties - The common properties of a service. Properties *ServicesProperties `json:"properties,omitempty"` // ID - READ-ONLY; The resource identifier. ID *string `json:"id,omitempty"` // Name - READ-ONLY; The resource name. Name *string `json:"name,omitempty"` // Type - READ-ONLY; The resource type. Type *string `json:"type,omitempty"` // Kind - The kind of the service. Possible values include: 'Fhir', 'FhirStu3', 'FhirR4' Kind Kind `json:"kind,omitempty"` // Location - The resource location. Location *string `json:"location,omitempty"` // Tags - The resource tags. Tags map[string]*string `json:"tags"` // Etag - An etag associated with the resource, used for optimistic concurrency when editing it. Etag *string `json:"etag,omitempty"` // Identity - Setting indicating whether the service has a managed identity associated with it. Identity *ResourceIdentity `json:"identity,omitempty"` }
ServicesDescription the description of the service.
func (ServicesDescription) MarshalJSON ¶
func (sd ServicesDescription) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServicesDescription.
type ServicesDescriptionListResult ¶
type ServicesDescriptionListResult struct { autorest.Response `json:"-"` // NextLink - The link used to get the next page of service description objects. NextLink *string `json:"nextLink,omitempty"` // Value - A list of service description objects. Value *[]ServicesDescription `json:"value,omitempty"` }
ServicesDescriptionListResult a list of service description objects with a next link.
func (ServicesDescriptionListResult) IsEmpty ¶
func (sdlr ServicesDescriptionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ServicesDescriptionListResultIterator ¶
type ServicesDescriptionListResultIterator struct {
// contains filtered or unexported fields
}
ServicesDescriptionListResultIterator provides access to a complete listing of ServicesDescription values.
func NewServicesDescriptionListResultIterator ¶
func NewServicesDescriptionListResultIterator(page ServicesDescriptionListResultPage) ServicesDescriptionListResultIterator
Creates a new instance of the ServicesDescriptionListResultIterator type.
func (*ServicesDescriptionListResultIterator) Next ¶
func (iter *ServicesDescriptionListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*ServicesDescriptionListResultIterator) NextWithContext ¶
func (iter *ServicesDescriptionListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (ServicesDescriptionListResultIterator) NotDone ¶
func (iter ServicesDescriptionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (ServicesDescriptionListResultIterator) Response ¶
func (iter ServicesDescriptionListResultIterator) Response() ServicesDescriptionListResult
Response returns the raw server response from the last page request.
func (ServicesDescriptionListResultIterator) Value ¶
func (iter ServicesDescriptionListResultIterator) Value() ServicesDescription
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ServicesDescriptionListResultPage ¶
type ServicesDescriptionListResultPage struct {
// contains filtered or unexported fields
}
ServicesDescriptionListResultPage contains a page of ServicesDescription values.
func NewServicesDescriptionListResultPage ¶
func NewServicesDescriptionListResultPage(cur ServicesDescriptionListResult, getNextPage func(context.Context, ServicesDescriptionListResult) (ServicesDescriptionListResult, error)) ServicesDescriptionListResultPage
Creates a new instance of the ServicesDescriptionListResultPage type.
func (*ServicesDescriptionListResultPage) Next ¶
func (page *ServicesDescriptionListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*ServicesDescriptionListResultPage) NextWithContext ¶
func (page *ServicesDescriptionListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (ServicesDescriptionListResultPage) NotDone ¶
func (page ServicesDescriptionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (ServicesDescriptionListResultPage) Response ¶
func (page ServicesDescriptionListResultPage) Response() ServicesDescriptionListResult
Response returns the raw server response from the last page request.
func (ServicesDescriptionListResultPage) Values ¶
func (page ServicesDescriptionListResultPage) Values() []ServicesDescription
Values returns the slice of values for the current page or nil if there are no values.
type ServicesNameAvailabilityInfo ¶
type ServicesNameAvailabilityInfo struct { autorest.Response `json:"-"` // NameAvailable - READ-ONLY; The value which indicates whether the provided name is available. NameAvailable *bool `json:"nameAvailable,omitempty"` // Reason - READ-ONLY; The reason for unavailability. Possible values include: 'Invalid', 'AlreadyExists' Reason ServiceNameUnavailabilityReason `json:"reason,omitempty"` // Message - The detailed reason message. Message *string `json:"message,omitempty"` }
ServicesNameAvailabilityInfo the properties indicating whether a given service name is available.
func (ServicesNameAvailabilityInfo) MarshalJSON ¶
func (snai ServicesNameAvailabilityInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServicesNameAvailabilityInfo.
type ServicesPatchDescription ¶
type ServicesPatchDescription struct { // Tags - Instance tags Tags map[string]*string `json:"tags"` }
ServicesPatchDescription the description of the service.
func (ServicesPatchDescription) MarshalJSON ¶
func (spd ServicesPatchDescription) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServicesPatchDescription.
type ServicesProperties ¶
type ServicesProperties struct { // ProvisioningState - READ-ONLY; The provisioning state. Possible values include: 'ProvisioningStateDeleting', 'ProvisioningStateSucceeded', 'ProvisioningStateCreating', 'ProvisioningStateAccepted', 'ProvisioningStateVerifying', 'ProvisioningStateUpdating', 'ProvisioningStateFailed', 'ProvisioningStateCanceled', 'ProvisioningStateDeprovisioned' ProvisioningState ProvisioningState `json:"provisioningState,omitempty"` // AccessPolicies - The access policies of the service instance. AccessPolicies *[]ServiceAccessPolicyEntry `json:"accessPolicies,omitempty"` // CosmosDbConfiguration - The settings for the Cosmos DB database backing the service. CosmosDbConfiguration *ServiceCosmosDbConfigurationInfo `json:"cosmosDbConfiguration,omitempty"` // AuthenticationConfiguration - The authentication configuration for the service instance. AuthenticationConfiguration *ServiceAuthenticationConfigurationInfo `json:"authenticationConfiguration,omitempty"` // CorsConfiguration - The settings for the CORS configuration of the service instance. CorsConfiguration *ServiceCorsConfigurationInfo `json:"corsConfiguration,omitempty"` // ExportConfiguration - The settings for the export operation of the service instance. ExportConfiguration *ServiceExportConfigurationInfo `json:"exportConfiguration,omitempty"` }
ServicesProperties the properties of a service instance.
func (ServicesProperties) MarshalJSON ¶
func (sp ServicesProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServicesProperties.
type ServicesUpdateFuture ¶
type ServicesUpdateFuture struct { azure.FutureAPI // Result returns the result of the asynchronous operation. // If the operation has not completed it will return an error. Result func(ServicesClient) (ServicesDescription, error) }
ServicesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*ServicesUpdateFuture) UnmarshalJSON ¶
func (future *ServicesUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Deprecated: Please note, this package has been deprecated.
|
Deprecated: Please note, this package has been deprecated. |