default_rollouts

Creates, updates, deletes, gets or lists a default_rollouts resource.

Overview

Name	default_rollouts
Type	Resource
Id	azure.provider_hub.default_rollouts

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the default rollout details.

Name	Datatype	Description
properties	object	Properties of the rollout.

list_by_provider_registration

Successfully retrieved the list of default rollouts.

Name	Datatype	Description
properties	object	Properties of the rollout.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, providerNamespace, rolloutName		Gets the default rollout details.
list_by_provider_registration	select	subscriptionId, providerNamespace		Gets the list of the rollouts for the given provider.
create_or_update	insert	subscriptionId, providerNamespace, rolloutName		Creates or updates the rollout details.
delete	delete	subscriptionId, providerNamespace, rolloutName		Deletes the rollout resource. Rollout must be in terminal state.
stop	exec	subscriptionId, providerNamespace, rolloutName		Stops or cancels the rollout, if in progress.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
providerNamespace	string	The name of the resource provider hosted within ProviderHub.
rolloutName	string	The rollout name.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets the default rollout details.

SELECT
properties
FROM azure.provider_hub.default_rollouts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND providerNamespace = '{{ providerNamespace }}' -- required
AND rolloutName = '{{ rolloutName }}' -- required
;

list_by_provider_registration

Gets the list of the rollouts for the given provider.

SELECT
properties
FROM azure.provider_hub.default_rollouts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND providerNamespace = '{{ providerNamespace }}' -- required
;

INSERT examples

create_or_update

Creates or updates the rollout details.

INSERT INTO azure.provider_hub.default_rollouts (
data__properties,
subscriptionId,
providerNamespace,
rolloutName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ providerNamespace }}',
'{{ rolloutName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: default_rollouts
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the default_rollouts resource.
    - name: providerNamespace
      value: string
      description: Required parameter for the default_rollouts resource.
    - name: rolloutName
      value: string
      description: Required parameter for the default_rollouts resource.
    - name: properties
      value: object
      description: |
        Properties of the rollout.

DELETE examples

delete

Deletes the rollout resource. Rollout must be in terminal state.

DELETE FROM azure.provider_hub.default_rollouts
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND providerNamespace = '{{ providerNamespace }}' --required
AND rolloutName = '{{ rolloutName }}' --required
;

Lifecycle Methods

stop

Stops or cancels the rollout, if in progress.

EXEC azure.provider_hub.default_rollouts.stop 
@subscriptionId='{{ subscriptionId }}' --required, 
@providerNamespace='{{ providerNamespace }}' --required, 
@rolloutName='{{ rolloutName }}' --required
;