client

package
v0.4.0 Latest Latest
Warning

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

 Go to latest Published: Feb 11, 2025 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CredRequestDefinition 

type CredRequestDefinition struct {
	// The custom claims to include into X509 Certificate
	CustomClaims *CustomClaims

	// The source resource identities.
	DelegatedResources []string

	// The identities to retrieve.
	IdentityIDs []string
}

func (CredRequestDefinition) MarshalJSON 

func (c CredRequestDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CredRequestDefinition.

func (*CredRequestDefinition) UnmarshalJSON 

func (c *CredRequestDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CredRequestDefinition.

type CustomClaims 

type CustomClaims struct {
	// The list of network perimeter ids. Maximum 5 network perimeter ids are supported
	XMSAzNwperimid []string

	// The trust mode of the azure resource asserted by RP. The value can either be 'azureinfra' or 'user'
	XMSAzTm *string
}

CustomClaims - The custom claims to include into X509 Certificate

func (CustomClaims) MarshalJSON 

func (c CustomClaims) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomClaims.

func (*CustomClaims) UnmarshalJSON 

func (c *CustomClaims) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CustomClaims.

type DelegatedResource 

type DelegatedResource struct {
	// MIRP delegationRecord persistent id.
	DelegationID *string

	// URL to perform RP-to-RP delegation for non-ARM resources, requiring manual onboarding via MIRP team.
	DelegationURL *string

	// The identities requested by the caller.
	ExplicitIdentities []UserAssignedIdentityCredentials

	// A managed identity credentials object.
	ImplicitIdentity *UserAssignedIdentityCredentials

	// Source resource Azure resource internal id.
	InternalID *string

	// Source resource Azure resource id.
	ResourceID *string
}

DelegatedResource - A delegated resource credentials object

func (DelegatedResource) MarshalJSON 

func (d DelegatedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DelegatedResource.

func (*DelegatedResource) UnmarshalJSON 

func (d *DelegatedResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DelegatedResource.

type ErrorResponse 

type ErrorResponse struct {
	Error *ErrorResponseError
}

func (ErrorResponse) MarshalJSON 

func (e ErrorResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

func (*ErrorResponse) UnmarshalJSON 

func (e *ErrorResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponse.

type ErrorResponseError 

type ErrorResponseError struct {
	// The error code.
	Code *string

	// A message describing the error.
	Message *string
}

func (ErrorResponseError) MarshalJSON 

func (e ErrorResponseError) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorResponseError.

func (*ErrorResponseError) UnmarshalJSON 

func (e *ErrorResponseError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponseError.

type ManagedIdentityCredentials 

type ManagedIdentityCredentials struct {
	// The AAD authentication endpoint for the identity system assigned identity. You can make token request toward this authentication
	// endpoint.
	AuthenticationEndpoint *string

	// The time after which the system assigned clientsecret cannot be used to call clientsecret_url for a refreshed credential
	// in the formate 2017-03-01T14:11:00Z.
	CannotRenewAfter *string

	// The AAD client id for the system assigned identity.
	ClientID *string

	// The base64 encoded private key X509 certificate for the system assigned identity, encrypted via AES256+SHA256.
	ClientSecret *string

	// A refreshed version of the URL used to retrieve credentials for the system assigned identity.
	ClientSecretURL *string

	// The custom claims to include into X509 Certificate
	CustomClaims *CustomClaims

	// The delegated resources' credentials requested by the caller.
	DelegatedResources []DelegatedResource

	// URL to perform RP-to-RP delegation for non-ARM resources, requiring manual onboarding via MIRP team.
	DelegationURL *string

	// The user assigned identities requested by the caller. This array will be empty for system assigned credential only requests.
	ExplicitIdentities []UserAssignedIdentityCredentials

	// An internal identifier for the resource in managed identity RP.
	InternalID *string

	// The AAD mTLS authentication endpoint for the system assigned identity. You can make a token request with a short-lived
	// credential toward this authentication endpoint.
	MtlsAuthenticationEndpoint *string

	// The time at which the system assigned credential becomes invalid for retireving AAD tokens in the format 2017-03-01T14:11:00Z.
	NotAfter *string

	// The time at which the system assigned credential becomes valid for retireving AAD tokens in the format 2017-03-01T14:11:00Z.
	NotBefore *string

	// The AAD object id for the system assigned identity.
	ObjectID *string

	// The time after which a call to the system assigned clientsecreturl will return a new credential in the format 2017-03-01T14:11:00Z.
	RenewAfter *string

	// The AAD tenant id for the system assigned identity.
	TenantID *string
}

ManagedIdentityCredentials - A system assigned managed identity + user assigned managed identity array.

func (ManagedIdentityCredentials) MarshalJSON 

func (m ManagedIdentityCredentials) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedIdentityCredentials.

func (*ManagedIdentityCredentials) UnmarshalJSON 

func (m *ManagedIdentityCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedIdentityCredentials.

type ManagedIdentityDataPlaneAPIClient 

type ManagedIdentityDataPlaneAPIClient struct {
	// contains filtered or unexported fields
}

ManagedIdentityDataPlaneAPIClient contains the methods for the ManagedIdentityDataPlaneAPI group. Don't use this type directly, use a constructor function instead.

func NewManagedIdentityDataPlaneAPIClient 

func NewManagedIdentityDataPlaneAPIClient(delegate *azcore.Client) *ManagedIdentityDataPlaneAPIClient

NewManagedIdentityDataPlaneAPIClient creates a new MSI data-plane client.

func (*ManagedIdentityDataPlaneAPIClient) Deleteidentity 

func (client *ManagedIdentityDataPlaneAPIClient) Deleteidentity(ctx context.Context, hostPath string, options *ManagedIdentityDataPlaneAPIClientDeleteidentityOptions) (ManagedIdentityDataPlaneAPIClientDeleteidentityResponse, error)

Deleteidentity - A DELETE operation to delete system assigned identity for a given proxy resource. The x-ms-identity-url header from ARM contains this path by default. This must be called by RPs only. Usable from only system assigned clientsecreturl. User assigned clientsecreturl does not support this operation. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-01-01

  • hostPath - The scheme, host and path from ARM's x-ms-identity-url header.
  • options - ManagedIdentityDataPlaneAPIClientDeleteidentityOptions contains the optional parameters for the ManagedIdentityDataPlaneAPIClient.Deleteidentity method.

func (*ManagedIdentityDataPlaneAPIClient) Getcred 

func (client *ManagedIdentityDataPlaneAPIClient) Getcred(ctx context.Context, hostPath string, options *ManagedIdentityDataPlaneAPIClientGetcredOptions) (ManagedIdentityDataPlaneAPIClientGetcredResponse, error)

Getcred - A GET operation to retrieve system or user assigned credentials for a given resource. The x-ms-identity-url header from ARM contains this path by default for system assigned identities. Usable from both system assigned clientsecreturl or user assigned clientsecreturl. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-01-01

  • hostPath - The scheme, host and path from ARM's x-ms-identity-url header.
  • options - ManagedIdentityDataPlaneAPIClientGetcredOptions contains the optional parameters for the ManagedIdentityDataPlaneAPIClient.Getcred method.

func (*ManagedIdentityDataPlaneAPIClient) Getcreds 

func (client *ManagedIdentityDataPlaneAPIClient) Getcreds(ctx context.Context, hostPath string, credRequest CredRequestDefinition, options *ManagedIdentityDataPlaneAPIClientGetcredsOptions) (ManagedIdentityDataPlaneAPIClientGetcredsResponse, error)

Getcreds - A POST operation to retrieve system assigned and user assigned identity credentials for a given resource. Usable from both system assigned clientsecreturl and user assigned clientsecreturl. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-01-01

  • hostPath - The scheme, host and path from ARM's x-ms-identity-url header.
  • credRequest - The identities requested.
  • options - ManagedIdentityDataPlaneAPIClientGetcredsOptions contains the optional parameters for the ManagedIdentityDataPlaneAPIClient.Getcreds method.

func (*ManagedIdentityDataPlaneAPIClient) Moveidentity 

func (client *ManagedIdentityDataPlaneAPIClient) Moveidentity(ctx context.Context, hostPath string, moveRequestBody MoveRequestBodyDefinition, options *ManagedIdentityDataPlaneAPIClientMoveidentityOptions) (ManagedIdentityDataPlaneAPIClientMoveidentityResponse, error)

Moveidentity - A POST operation to move the proxy resource to a different resource group If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-01-01

  • hostPath - The scheme, host and path from ARM's x-ms-identity-url header.
  • moveRequestBody - New target resource Id
  • options - ManagedIdentityDataPlaneAPIClientMoveidentityOptions contains the optional parameters for the ManagedIdentityDataPlaneAPIClient.Moveidentity method.

type ManagedIdentityDataPlaneAPIClientDeleteidentityOptions 

type ManagedIdentityDataPlaneAPIClientDeleteidentityOptions struct {
}

ManagedIdentityDataPlaneAPIClientDeleteidentityOptions contains the optional parameters for the ManagedIdentityDataPlaneAPIClient.Deleteidentity method.

type ManagedIdentityDataPlaneAPIClientDeleteidentityResponse 

type ManagedIdentityDataPlaneAPIClientDeleteidentityResponse struct {
}

ManagedIdentityDataPlaneAPIClientDeleteidentityResponse contains the response from method ManagedIdentityDataPlaneAPIClient.Deleteidentity.

type ManagedIdentityDataPlaneAPIClientGetcredOptions 

type ManagedIdentityDataPlaneAPIClientGetcredOptions struct {
}

ManagedIdentityDataPlaneAPIClientGetcredOptions contains the optional parameters for the ManagedIdentityDataPlaneAPIClient.Getcred method.

type ManagedIdentityDataPlaneAPIClientGetcredResponse 

type ManagedIdentityDataPlaneAPIClientGetcredResponse struct {
	// A system assigned managed identity + user assigned managed identity array.
	ManagedIdentityCredentials
}

ManagedIdentityDataPlaneAPIClientGetcredResponse contains the response from method ManagedIdentityDataPlaneAPIClient.Getcred.

type ManagedIdentityDataPlaneAPIClientGetcredsOptions 

type ManagedIdentityDataPlaneAPIClientGetcredsOptions struct {
}

ManagedIdentityDataPlaneAPIClientGetcredsOptions contains the optional parameters for the ManagedIdentityDataPlaneAPIClient.Getcreds method.

type ManagedIdentityDataPlaneAPIClientGetcredsResponse 

type ManagedIdentityDataPlaneAPIClientGetcredsResponse struct {
	// A system assigned managed identity + user assigned managed identity array.
	ManagedIdentityCredentials
}

ManagedIdentityDataPlaneAPIClientGetcredsResponse contains the response from method ManagedIdentityDataPlaneAPIClient.Getcreds.

type ManagedIdentityDataPlaneAPIClientMoveidentityOptions 

type ManagedIdentityDataPlaneAPIClientMoveidentityOptions struct {
}

ManagedIdentityDataPlaneAPIClientMoveidentityOptions contains the optional parameters for the ManagedIdentityDataPlaneAPIClient.Moveidentity method.

type ManagedIdentityDataPlaneAPIClientMoveidentityResponse 

type ManagedIdentityDataPlaneAPIClientMoveidentityResponse struct {
	MoveIdentityResponse
}

ManagedIdentityDataPlaneAPIClientMoveidentityResponse contains the response from method ManagedIdentityDataPlaneAPIClient.Moveidentity.

type MoveIdentityResponse 

type MoveIdentityResponse struct {
	// the new identity url of the resource.
	IdentityURL *string
}

func (MoveIdentityResponse) MarshalJSON 

func (m MoveIdentityResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MoveIdentityResponse.

func (*MoveIdentityResponse) UnmarshalJSON 

func (m *MoveIdentityResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MoveIdentityResponse.

type MoveRequestBodyDefinition 

type MoveRequestBodyDefinition struct {
	// New Resource Id of the resource that will be moved to.
	TargetResourceID *string
}

func (MoveRequestBodyDefinition) MarshalJSON 

func (m MoveRequestBodyDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MoveRequestBodyDefinition.

func (*MoveRequestBodyDefinition) UnmarshalJSON 

func (m *MoveRequestBodyDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MoveRequestBodyDefinition.

type UserAssignedIdentityCredentials 

type UserAssignedIdentityCredentials struct {
	// The AAD authentication endpoint for the user assigned identity. You can make token request toward this authentication endpoint.
	AuthenticationEndpoint *string

	// The time after which the user assigned clientsecret cannot be used to call clientsecret_url for a refreshed credential
	// in the formate 2017-03-01T14:11:00Z.
	CannotRenewAfter *string

	// The AAD client id for the user assigned identity.
	ClientID *string

	// The base64 encoded private key X509 certificate for the user assigned identity, encrypted via AES256+SHA256.
	ClientSecret *string

	// A refreshed version of the URL used to retrieve credentials for the user assigned identity.
	ClientSecretURL *string

	// The custom claims to include into X509 Certificate
	CustomClaims *CustomClaims

	// The AAD mTLS authentication endpoint for the system assigned identity. You can make a token request with a short-lived
	// credential toward this authentication endpoint.
	MtlsAuthenticationEndpoint *string

	// The time at which the user assigned credential becomes invalid for retireving AAD tokens in the format 2017-03-01T14:11:00Z.
	NotAfter *string

	// The time at which the user assigned credential becomes valid for retireving AAD tokens in the format 2017-03-01T14:11:00Z.
	NotBefore *string

	// The AAD object id for the user assigned identity.
	ObjectID *string

	// The time after which a call to the user assigned clientsecreturl will return a new credential in the format 2017-03-01T14:11:00Z.
	RenewAfter *string

	// The ARM resource id for the user assigned identity.
	ResourceID *string

	// The AAD tenant id for the user assigned identity.
	TenantID *string
}

UserAssignedIdentityCredentials - A managed identity credentials object.

func (UserAssignedIdentityCredentials) MarshalJSON 

func (u UserAssignedIdentityCredentials) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserAssignedIdentityCredentials.

func (*UserAssignedIdentityCredentials) UnmarshalJSON 

func (u *UserAssignedIdentityCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserAssignedIdentityCredentials.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.